1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** FileX Component */
16 /** */
17 /** File */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define FX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "fx_api.h"
28 #include "fx_file.h"
29
30
31 FX_CALLER_CHECKING_EXTERNS
32
33
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _fxe_file_write_notify_set PORTABLE C */
39 /* 6.1 */
40 /* AUTHOR */
41 /* */
42 /* William E. Lamie, Microsoft Corporation */
43 /* */
44 /* DESCRIPTION */
45 /* */
46 /* This function checks for errors in the file write notify set. */
47 /* */
48 /* INPUT */
49 /* */
50 /* file_ptr File control block pointer */
51 /* file_write_notify Notify function called when */
52 /* file is written to */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* FX_PTR_ERROR media_ptr is NULL */
57 /* status Actual completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _fx_file_write_notify Actual file write notify set */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* Application Code */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
72 /* 09-30-2020 William E. Lamie Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* */
75 /**************************************************************************/
_fxe_file_write_notify_set(FX_FILE * file_ptr,VOID (* file_write_notify)(FX_FILE * file))76 UINT _fxe_file_write_notify_set(FX_FILE *file_ptr, VOID (*file_write_notify)(FX_FILE *file))
77 {
78 UINT status;
79
80 /* Check for invalid input pointers. */
81 if (file_ptr == FX_NULL)
82 {
83 return(FX_PTR_ERROR);
84 }
85
86 /* Check for a valid caller. */
87 FX_CALLER_CHECKING_CODE
88
89 /* Call actual file write notify set service. */
90 status = _fx_file_write_notify_set(file_ptr, file_write_notify);
91
92 /* Return status. */
93 return(status);
94 }
95
96
