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 /** GUIX Component */
16 /** */
17 /** Utility (Utility) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_utility.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gx_utility_string_length_check PORTABLE C */
34 /* 6.1 */
35 /* AUTHOR */
36 /* */
37 /* Kenneth Maxwell, Microsoft Corporation */
38 /* */
39 /* DESCRIPTION */
40 /* */
41 /* This function traverses the string and returns the string length, */
42 /* if the string is invalid or the string length is bigger than max */
43 /* string length, returns error. */
44 /* */
45 /* INPUT */
46 /* */
47 /* input_string Pointer to input string */
48 /* string_length Pointer to string length */
49 /* max_string_length Max string length */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* None */
54 /* */
55 /* CALLS */
56 /* */
57 /* None */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* GUIX Internal Code */
62 /* */
63 /* RELEASE HISTORY */
64 /* */
65 /* DATE NAME DESCRIPTION */
66 /* */
67 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
68 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
69 /* resulting in version 6.1 */
70 /* */
71 /**************************************************************************/
_gx_utility_string_length_check(GX_CONST GX_CHAR * input_string,UINT * string_length,UINT max_string_length)72 UINT _gx_utility_string_length_check(GX_CONST GX_CHAR *input_string, UINT *string_length, UINT max_string_length)
73 {
74 UINT i;
75
76 /* Check for invalid input pointers. */
77 if (input_string == GX_NULL)
78 {
79 return(GX_PTR_ERROR);
80 }
81
82 /* Traverse the string. */
83 for (i = 0; input_string[i]; i++)
84 {
85
86 /* Check if the string length is bigger than the max string length. */
87 if (i >= max_string_length)
88 {
89 return(GX_INVALID_STRING_LENGTH);
90 }
91 }
92
93 /* Return the string length if string_length is not NULL.
94 String_length being NULL indicates the caller needs to check for string
95 length within the max_string_length. */
96 if (string_length)
97 {
98 *string_length = i;
99 }
100
101 return(GX_SUCCESS);
102 }
103
104
