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 /** Directory */
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_directory.h"
29
30 FX_CALLER_CHECKING_EXTERNS
31
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _fxe_directory_default_get 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 directory default get call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* media_ptr Media control block pointer */
50 /* return_path_name Destination string pointer */
51 /* address */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* return status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _fx_directory_default_get Actual default directory get */
60 /* service */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
71 /* 09-30-2020 William E. Lamie Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_fxe_directory_default_get(FX_MEDIA * media_ptr,CHAR ** return_path_name)75 UINT _fxe_directory_default_get(FX_MEDIA *media_ptr, CHAR **return_path_name)
76 {
77
78 UINT status;
79
80
81 /* Check for a null media pointer or null destination for the default path. */
82 if ((media_ptr == FX_NULL) || (return_path_name == FX_NULL))
83 {
84 return(FX_PTR_ERROR);
85 }
86
87 /* Check for a valid caller. */
88 FX_CALLER_CHECKING_CODE
89
90 /* Call actual default directory get service. */
91 status = _fx_directory_default_get(media_ptr, return_path_name);
92
93 /* Return default directory get status. */
94 return(status);
95 }
96
97
