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 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _fxe_unicode_short_name_get_extended                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 Unicode short name get       */
46 /*    service.                                                            */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    media_ptr                             Pointer to media              */
51 /*    source_unicode_name                   Pointer to unicode name       */
52 /*    source_unicode_length                 Length of unicode name        */
53 /*    destination_short_name                Pointer to destination name   */
54 /*    short_name_buffer_length              Buffer length of short name   */
55 /*                                                                        */
56 /*  OUTPUT                                                                */
57 /*                                                                        */
58 /*    Completion Status                                                   */
59 /*                                                                        */
60 /*  CALLS                                                                 */
61 /*                                                                        */
62 /*    _fx_unicode_short_name_get_extended   Actual unicode short name get */
63 /*                                            service                     */
64 /*                                                                        */
65 /*  CALLED BY                                                             */
66 /*                                                                        */
67 /*    Application Code                                                    */
68 /*                                                                        */
69 /*  RELEASE HISTORY                                                       */
70 /*                                                                        */
71 /*    DATE              NAME                      DESCRIPTION             */
72 /*                                                                        */
73 /*  05-19-2020     William E. Lamie         Initial Version 6.0           */
74 /*  09-30-2020     William E. Lamie         Modified comment(s),          */
75 /*                                            resulting in version 6.1    */
76 /*                                                                        */
77 /**************************************************************************/
_fxe_unicode_short_name_get_extended(FX_MEDIA * media_ptr,UCHAR * source_unicode_name,ULONG source_unicode_length,CHAR * destination_short_name,ULONG short_name_buffer_length)78 UINT  _fxe_unicode_short_name_get_extended(FX_MEDIA *media_ptr, UCHAR *source_unicode_name, ULONG source_unicode_length,
79                                   CHAR *destination_short_name, ULONG short_name_buffer_length)
80 {
81 
82 UINT status, i;
83 
84 
85     /* Check for a NULL media or name pointers.  */
86     if ((media_ptr == FX_NULL) || (source_unicode_name == FX_NULL) || (source_unicode_length == 0) || (destination_short_name == FX_NULL))
87     {
88         return(FX_PTR_ERROR);
89     }
90 
91     /* Check for zero length buffer.  */
92     if (short_name_buffer_length == 0)
93     {
94         return(FX_BUFFER_ERROR);
95     }
96 
97     /* Check for a valid caller.  */
98     FX_CALLER_CHECKING_CODE
99 
100     /* Check unicode zero in source_unicode_name */
101     for (i = 0; i < (source_unicode_length << 1); i += 2)
102     {
103         if ((source_unicode_name[i] == 0) && (source_unicode_name[i + 1] == 0))
104         {
105             return(FX_INVALID_NAME);
106         }
107     }
108 
109     /* Call actual Unicode short name get service.  */
110     status =  _fx_unicode_short_name_get_extended(media_ptr, source_unicode_name, source_unicode_length, destination_short_name, short_name_buffer_length);
111 
112     /* Return status to the caller.  */
113     return(status);
114 }
115 
116