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_local_path_get_copy                  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 local path get copy call.    */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    media_ptr                             Media control block pointer   */
50 /*    return_path_name_buffer               Destination buffer for name   */
51 /*    return_path_name_buffer_size          Size of buffer pointed to by  */
52 /*                                            return_path_name_buffer     */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    return status                                                       */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    None                                                                */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    Application Code                                                    */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  05-19-2020     William E. Lamie         Initial Version 6.0           */
70 /*  09-30-2020     William E. Lamie         Modified comment(s),          */
71 /*                                            resulting in version 6.1    */
72 /*                                                                        */
73 /**************************************************************************/
_fxe_directory_local_path_get_copy(FX_MEDIA * media_ptr,CHAR * return_path_name_buffer,UINT return_path_name_buffer_size)74 UINT  _fxe_directory_local_path_get_copy(FX_MEDIA *media_ptr, CHAR *return_path_name_buffer, UINT return_path_name_buffer_size)
75 {
76 
77 UINT status;
78 
79 
80     /* Check for a null media pointer or name buffer pointer.  */
81     if ((media_ptr == FX_NULL) || (return_path_name_buffer == 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 default directory get copy service.  */
90     status =  _fx_directory_local_path_get_copy(media_ptr, return_path_name_buffer, return_path_name_buffer_size);
91 
92     /* Return successful status.  */
93     return(status);
94 }
95