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 FX_CALLER_CHECKING_EXTERNS
31
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _fxe_file_read PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* William E. Lamie, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks for errors in the read file call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* file_ptr File control block pointer */
50 /* buffer_ptr Buffer pointer */
51 /* request_size Number of bytes requested */
52 /* actual_size Pointer to variable for the */
53 /* number of bytes read */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* return status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _fx_file_read Actual file read service */
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_read(FX_FILE * file_ptr,VOID * buffer_ptr,ULONG request_size,ULONG * actual_size)76 UINT _fxe_file_read(FX_FILE *file_ptr, VOID *buffer_ptr, ULONG request_size, ULONG *actual_size)
77 {
78
79 UINT status;
80
81
82 /* Check for a null file or buffer pointer. */
83 if ((file_ptr == FX_NULL) || (buffer_ptr == FX_NULL) || (actual_size == FX_NULL))
84 {
85 return(FX_PTR_ERROR);
86 }
87
88 /* Check for a valid caller. */
89 FX_CALLER_CHECKING_CODE
90
91 /* Call actual file read service. */
92 status = _fx_file_read(file_ptr, buffer_ptr, request_size, actual_size);
93
94 /* Return status to the caller. */
95 return(status);
96 }
97
98
