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_seek 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 file seek call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* file_ptr File control block pointer */
50 /* byte_offset Byte offset into the file */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* return status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _fx_file_seek Actual file seek service */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Application Code */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
69 /* 09-30-2020 William E. Lamie Modified comment(s), */
70 /* resulting in version 6.1 */
71 /* */
72 /**************************************************************************/
_fxe_file_seek(FX_FILE * file_ptr,ULONG byte_offset)73 UINT _fxe_file_seek(FX_FILE *file_ptr, ULONG byte_offset)
74 {
75
76 UINT status;
77
78
79 /* Check for a null file pointer. */
80 if (file_ptr == FX_NULL)
81 {
82 return(FX_PTR_ERROR);
83 }
84
85 /* Check for a valid caller. */
86 FX_CALLER_CHECKING_CODE
87
88 /* Call actual file seek service. */
89 status = _fx_file_seek(file_ptr, byte_offset);
90
91 /* Seek is complete, return status. */
92 return(status);
93 }
94
95
