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 /**   Unicode                                                             */
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_unicode.h"
29 
30 
31 FX_CALLER_CHECKING_EXTERNS
32 
33 
34 /**************************************************************************/
35 /*                                                                        */
36 /*  FUNCTION                                               RELEASE        */
37 /*                                                                        */
38 /*    _fxe_unicode_name_get_extended                      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 Unicode name get             */
47 /*    service.                                                            */
48 /*                                                                        */
49 /*  INPUT                                                                 */
50 /*                                                                        */
51 /*    media_ptr                             Pointer to media              */
52 /*    source_short_name                     Pointer to short file name    */
53 /*    destination_unicode_name              Pointer to destination name   */
54 /*    destination_unicode_length            Destination for name length   */
55 /*    unicode_name_buffer_length            Buffer length of unicode name */
56 /*                                                                        */
57 /*  OUTPUT                                                                */
58 /*                                                                        */
59 /*    Completion Status                                                   */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    _fx_unicode_name_get_extended         Actual unicode name get       */
64 /*                                            service                     */
65 /*                                                                        */
66 /*  CALLED BY                                                             */
67 /*                                                                        */
68 /*    Application Code                                                    */
69 /*                                                                        */
70 /*  RELEASE HISTORY                                                       */
71 /*                                                                        */
72 /*    DATE              NAME                      DESCRIPTION             */
73 /*                                                                        */
74 /*  05-19-2020     William E. Lamie         Initial Version 6.0           */
75 /*  09-30-2020     William E. Lamie         Modified comment(s),          */
76 /*                                            resulting in version 6.1    */
77 /*                                                                        */
78 /**************************************************************************/
_fxe_unicode_name_get_extended(FX_MEDIA * media_ptr,CHAR * source_short_name,UCHAR * destination_unicode_name,ULONG * destination_unicode_length,ULONG unicode_name_buffer_length)79 UINT  _fxe_unicode_name_get_extended(FX_MEDIA *media_ptr, CHAR *source_short_name,
80                             UCHAR *destination_unicode_name, ULONG *destination_unicode_length, ULONG unicode_name_buffer_length)
81 {
82 
83 UINT status;
84 
85 
86     /* Check for a NULL media or name pointers.  */
87     if ((media_ptr == FX_NULL) || (source_short_name == FX_NULL) || (destination_unicode_name == FX_NULL) || (destination_unicode_length == FX_NULL))
88     {
89         return(FX_PTR_ERROR);
90     }
91 
92     /* Check for zero length buffer.  */
93     if (unicode_name_buffer_length == 0)
94     {
95         return(FX_BUFFER_ERROR);
96     }
97 
98     /* Check for a valid caller.  */
99     FX_CALLER_CHECKING_CODE
100 
101     /* Call actual Unicode name get service.  */
102     status =  _fx_unicode_name_get_extended(media_ptr, source_short_name,
103                                    destination_unicode_name, destination_unicode_length, unicode_name_buffer_length);
104 
105     /* Return status to the caller.  */
106     return(status);
107 }
108 
109