nlsboot.c File Reference

#include "precomp.h"

Go to the source code of this file.

Defines
#define	upcase(C)   (WCHAR )(((C) >= 'a' && (C) <= 'z' ? (C) - ('a' - 'A') : (C)))
Functions
NTSTATUS	RtlAnsiStringToUnicodeString (OUT PUNICODE_STRING DestinationString, IN PANSI_STRING SourceString, IN BOOLEAN AllocateDestinationString)
LONG	RtlCompareUnicodeString (IN PUNICODE_STRING String1, IN PUNICODE_STRING String2, IN BOOLEAN CaseInSensitive)
BOOLEAN	RtlEqualUnicodeString (IN const PUNICODE_STRING String1, IN const PUNICODE_STRING String2, IN BOOLEAN CaseInSensitive)
VOID	RtlInitString (OUT PSTRING DestinationString, IN PCSZ SourceString OPTIONAL)
VOID	RtlInitUnicodeString (OUT PUNICODE_STRING DestinationString, IN PCWSTR SourceString OPTIONAL)
NTSTATUS	RtlAppendUnicodeStringToString (IN PUNICODE_STRING Destination, IN PUNICODE_STRING Source)
NTSTATUS	RtlAppendUnicodeToString (IN PUNICODE_STRING Destination, IN PCWSTR Source OPTIONAL)
WCHAR	RtlUpcaseUnicodeChar (IN WCHAR SourceCharacter)
WCHAR	RtlAnsiCharToUnicodeChar (IN OUT PUCHAR *SourceCharacter)
NTSTATUS	RtlUpcaseUnicodeToMultiByteN (OUT PCH MultiByteString, IN ULONG MaxBytesInMultiByteString, OUT PULONG BytesInMultiByteString OPTIONAL, IN PWCH UnicodeString, IN ULONG BytesInUnicodeString)
NTSTATUS	RtlMultiByteToUnicodeN (OUT PWCH UnicodeString, IN ULONG MaxBytesInUnicodeString, OUT PULONG BytesInUnicodeString OPTIONAL, IN PCH MultiByteString, IN ULONG BytesInMultiByteString)
NTSTATUS	RtlUnicodeToMultiByteN (OUT PCH MultiByteString, IN ULONG MaxBytesInMultiByteString, OUT PULONG BytesInMultiByteString OPTIONAL, IN PWCH UnicodeString, IN ULONG BytesInUnicodeString)

---

Define Documentation

#define upcase (  C   )     (WCHAR )(((C) >= 'a' && (C) <= 'z' ? (C) - ('a' - 'A') : (C)))

Definition at line 33 of file nlsboot.c. Referenced by RtlCompareUnicodeString(), RtlEqualUnicodeString(), RtlPrefixUnicodeString(), and RtlUpcaseUnicodeChar().

---

Function Documentation

WCHAR RtlAnsiCharToUnicodeChar (  IN OUT PUCHAR *  SourceCharacter  )

Definition at line 464 of file nlsboot.c. References NTSTATUS(). : This function translates the specified ansi character to unicode and returns the unicode value. The purpose for this routine is to allow for character by character ansi to unicode translation. The translation is done with respect to the current system locale information. Arguments: SourceCharacter - Supplies a pointer to an ansi character pointer. Through two levels of indirection, this supplies an ansi character that is to be translated to unicode. After translation, the ansi character pointer is modified to point to the next character to be converted. This is done to allow for dbcs ansi characters. Return Value: Returns the unicode equivalent of the specified ansi character. --*/ { WCHAR UnicodeCharacter; ULONG cbCharSize; NTSTATUS st; UnicodeCharacter = (WCHAR)**SourceCharacter; (*SourceCharacter)++; return(UnicodeCharacter); }

NTSTATUS RtlAnsiStringToUnicodeString (  OUT PUNICODE_STRING  DestinationString, IN PANSI_STRING  SourceString, IN BOOLEAN  AllocateDestinationString )

Definition at line 37 of file nlsboot.c. References Index, NTSTATUS(), SourceString, and USHORT. { ULONG UnicodeLength; ULONG Index; NTSTATUS st; UnicodeLength = (SourceString->Length << 1) + sizeof(UNICODE_NULL); if ( UnicodeLength > MAXUSHORT ) { return STATUS_INVALID_PARAMETER_2; } DestinationString->Length = (USHORT)(UnicodeLength - sizeof(UNICODE_NULL)); if ( AllocateDestinationString ) { return STATUS_NO_MEMORY; } else { if ( DestinationString->Length >= DestinationString->MaximumLength ) { return STATUS_BUFFER_OVERFLOW; } } Index = 0; while(Index < DestinationString->Length ) { DestinationString->Buffer[Index] = (WCHAR)SourceString->Buffer[Index]; Index++; } DestinationString->Buffer[Index] = UNICODE_NULL; return STATUS_SUCCESS; }

NTSTATUS RtlAppendUnicodeStringToString (  IN PUNICODE_STRING  Destination, IN PUNICODE_STRING  Source )

Definition at line 320 of file nlsboot.c. References n, and USHORT. : This routine will concatinate two PSTRINGs together. It will copy bytes from the source up to the MaximumLength of the destination. Arguments: IN PSTRING Destination, - Supplies the destination string IN PSTRING Source - Supplies the source for the string copy Return Value: STATUS_SUCCESS - The source string was successfully appended to the destination counted string. STATUS_BUFFER_TOO_SMALL - The destination string length was not big enough to allow the source string to be appended. The Destination string length is not updated. --*/ { USHORT n = Source->Length; UNALIGNED WCHAR *dst; if (n) { if ((n + Destination->Length) > Destination->MaximumLength) { return( STATUS_BUFFER_TOO_SMALL ); } dst = &Destination->Buffer[ (Destination->Length / sizeof( WCHAR )) ]; RtlMoveMemory( dst, Source->Buffer, n ); Destination->Length += n; if (Destination->Length < Destination->MaximumLength) { dst[ n / sizeof( WCHAR ) ] = UNICODE_NULL; } } return( STATUS_SUCCESS ); }

NTSTATUS RtlAppendUnicodeToString (  IN PUNICODE_STRING  Destination, IN PCWSTR Source  OPTIONAL )

Definition at line 372 of file nlsboot.c. References n, RtlInitUnicodeString(), and USHORT. : This routine appends the supplied UNICODE string to an existing PUNICODE_STRING. It will copy bytes from the Source PSZ to the destination PSTRING up to the destinations PUNICODE_STRING->MaximumLength field. Arguments: IN PUNICODE_STRING Destination, - Supplies a pointer to the destination string IN PWSTR Source - Supplies the string to append to the destination Return Value: STATUS_SUCCESS - The source string was successfully appended to the destination counted string. STATUS_BUFFER_TOO_SMALL - The destination string length was not big enough to allow the source string to be appended. The Destination string length is not updated. --*/ { USHORT n; UNALIGNED WCHAR *dst; if (ARGUMENT_PRESENT( Source )) { UNICODE_STRING UniSource; RtlInitUnicodeString(&UniSource, Source); n = UniSource.Length; if ((n + Destination->Length) > Destination->MaximumLength) { return( STATUS_BUFFER_TOO_SMALL ); } dst = &Destination->Buffer[ (Destination->Length / sizeof( WCHAR )) ]; RtlMoveMemory( dst, Source, n ); Destination->Length += n; if (Destination->Length < Destination->MaximumLength) { dst[ n / sizeof( WCHAR ) ] = UNICODE_NULL; } } return( STATUS_SUCCESS ); }

LONG RtlCompareUnicodeString (  IN PUNICODE_STRING  String1, IN PUNICODE_STRING  String2, IN BOOLEAN  CaseInSensitive )

Definition at line 75 of file nlsboot.c. References String1, String2, upcase, and USHORT. 00083 : 00084 00085 The RtlCompareUnicodeString function compares two counted strings. The 00086 return value indicates if the strings are equal or String1 is less than 00087 String2 or String1 is greater than String2. 00088 00089 The CaseInSensitive parameter specifies if case is to be ignored when 00090 doing the comparison. 00091 00092 Arguments: 00093 00094 String1 - Pointer to the first string. 00095 00096 String2 - Pointer to the second string. 00097 00098 CaseInsensitive - TRUE if case should be ignored when doing the 00099 comparison. 00100 00101 Return Value: 00102 00103 Signed value that gives the results of the comparison: 00104 00105 Zero - String1 equals String2 00106 00107 < Zero - String1 less than String2 00108 00109 > Zero - String1 greater than String2 00110 00111 00112 --*/ 00113 00114 { 00115 00116 UNALIGNED WCHAR *s1, *s2; 00117 USHORT n1, n2; 00118 WCHAR c1, c2; 00119 LONG cDiff; 00120 00121 s1 = String1->Buffer; 00122 s2 = String2->Buffer; 00123 n1 = (USHORT )(String1->Length / sizeof(WCHAR)); 00124 n2 = (USHORT )(String2->Length / sizeof(WCHAR)); 00125 while (n1 && n2) { 00126 c1 = *s1++; 00127 c2 = *s2++; 00128 00129 if (CaseInSensitive) { 00130 // 00131 // Note that this needs to reference the translation table ! 00132 // 00133 c1 = upcase(c1); 00134 c2 = upcase(c2); 00135 } 00136 00137 if ((cDiff = ((LONG)c1 - (LONG)c2)) != 0) { 00138 return( cDiff ); 00139 } 00140 00141 n1--; 00142 n2--; 00143 } 00144 00145 return( n1 - n2 ); 00146 }

BOOLEAN RtlEqualUnicodeString (  IN const PUNICODE_STRING  String1, IN const PUNICODE_STRING  String2, IN BOOLEAN  CaseInSensitive )

Definition at line 149 of file nlsboot.c. References FALSE, String1, String2, TRUE, upcase, and USHORT. : The RtlEqualUnicodeString function compares two counted unicode strings for equality. The CaseInSensitive parameter specifies if case is to be ignored when doing the comparison. Arguments: String1 - Pointer to the first string. String2 - Pointer to the second string. CaseInsensitive - TRUE if case should be ignored when doing the comparison. Return Value: Boolean value that is TRUE if String1 equals String2 and FALSE otherwise. --*/ { UNALIGNED WCHAR *s1, *s2; USHORT n1, n2; WCHAR c1, c2; s1 = String1->Buffer; s2 = String2->Buffer; n1 = (USHORT )(String1->Length / sizeof(WCHAR)); n2 = (USHORT )(String2->Length / sizeof(WCHAR)); if ( n1 != n2 ) { return FALSE; } if (CaseInSensitive) { while ( n1 ) { if ( *s1++ != *s2++ ) { c1 = upcase(*(s1-1)); c2 = upcase(*(s2-1)); if (c1 != c2) { return( FALSE ); } } n1--; } } else { while ( n1 ) { if (*s1++ != *s2++) { return( FALSE ); } n1--; } } return TRUE; }

VOID RtlInitString (  OUT PSTRING  DestinationString, IN PCSZ SourceString  OPTIONAL )

Definition at line 225 of file nlsboot.c. References SHORT, and SourceString. : The RtlInitString function initializes an NT counted string. The DestinationString is initialized to point to the SourceString and the Length and MaximumLength fields of DestinationString are initialized to the length of the SourceString, which is zero if SourceString is not specified. Arguments: DestinationString - Pointer to the counted string to initialize SourceString - Optional pointer to a null terminated string that the counted string is to point to. Return Value: None. --*/ { DestinationString->Length = 0; DestinationString->Buffer = (PCHAR)SourceString; if (ARGUMENT_PRESENT( SourceString )) { while (*SourceString++) { DestinationString->Length++; } DestinationString->MaximumLength = (SHORT)(DestinationString->Length+1); } else { DestinationString->MaximumLength = 0; } }

VOID RtlInitUnicodeString (  OUT PUNICODE_STRING  DestinationString, IN PCWSTR SourceString  OPTIONAL )

Definition at line 271 of file nlsboot.c. References SourceString, and USHORT. : The RtlInitUnicodeString function initializes an NT counted unicode string. The DestinationString is initialized to point to the SourceString and the Length and MaximumLength fields of DestinationString are initialized to the length of the SourceString, which is zero if SourceString is not specified. Arguments: DestinationString - Pointer to the counted string to initialize SourceString - Optional pointer to a null terminated unicode string that the counted string is to point to. Return Value: None. --*/ { USHORT Length = 0; DestinationString->Length = 0; DestinationString->Buffer = (PWSTR)SourceString; if (ARGUMENT_PRESENT( SourceString )) { while (*SourceString++) { Length += sizeof(*SourceString); } DestinationString->Length = Length; DestinationString->MaximumLength = Length+(USHORT)sizeof(UNICODE_NULL); } else { DestinationString->MaximumLength = 0; } }

NTSTATUS RtlMultiByteToUnicodeN (  OUT PWCH  UnicodeString, IN ULONG  MaxBytesInUnicodeString, OUT PULONG BytesInUnicodeString  OPTIONAL, IN PCH  MultiByteString, IN ULONG  BytesInMultiByteString )

Definition at line 576 of file nlsboot.c. References PUSHORT. : This functions converts the specified ansi source string into a Unicode string. The translation is done with respect to the ANSI Code Page (ACP) installed at boot time. Single byte characters in the range 0x00 - 0x7f are simply zero extended as a performance enhancement. In some far eastern code pages 0x5c is defined as the Yen sign. For system translation we always want to consider 0x5c to be the backslash character. We get this for free by zero extending. NOTE: This routine only supports precomposed Unicode characters. Arguments: UnicodeString - Returns a unicode string that is equivalent to the ansi source string. MaxBytesInUnicodeString - Supplies the maximum number of bytes to be written to UnicodeString. If this causes UnicodeString to be a truncated equivalent of MultiByteString, no error condition results. BytesInUnicodeString - Returns the number of bytes in the returned unicode string pointed to by UnicodeString. MultiByteString - Supplies the ansi source string that is to be converted to unicode. BytesInMultiByteString - The number of bytes in the string pointed to by MultiByteString. Return Value: SUCCESS - The conversion was successful. --*/ { ULONG LoopCount; PUSHORT TranslateTable; ULONG MaxCharsInUnicodeString; ULONG i; MaxCharsInUnicodeString = MaxBytesInUnicodeString / sizeof(WCHAR); LoopCount = (MaxCharsInUnicodeString < BytesInMultiByteString) ? MaxCharsInUnicodeString : BytesInMultiByteString; if (ARGUMENT_PRESENT(BytesInUnicodeString)) *BytesInUnicodeString = LoopCount * sizeof(WCHAR); for (i=0;i<LoopCount;i++) { UnicodeString[i] = (WCHAR)((UCHAR)(MultiByteString[i])); } return(STATUS_SUCCESS); }

NTSTATUS RtlUnicodeToMultiByteN (  OUT PCH  MultiByteString, IN ULONG  MaxBytesInMultiByteString, OUT PULONG BytesInMultiByteString  OPTIONAL, IN PWCH  UnicodeString, IN ULONG  BytesInUnicodeString )

Definition at line 644 of file nlsboot.c. References CHAR. 00653 : 00654 00655 This functions converts the specified unicode source string into an 00656 ansi string. The translation is done with respect to the 00657 ANSI Code Page (ACP) loaded at boot time. 00658 00659 Arguments: 00660 00661 MultiByteString - Returns an ansi string that is equivalent to the 00662 unicode source string. If the translation can not be done, 00663 an error is returned. 00664 00665 MaxBytesInMultiByteString - Supplies the maximum number of bytes to be 00666 written to MultiByteString. If this causes MultiByteString to be a 00667 truncated equivalent of UnicodeString, no error condition results. 00668 00669 BytesInMultiByteString - Returns the number of bytes in the returned 00670 ansi string pointed to by MultiByteString. 00671 00672 UnicodeString - Supplies the unicode source string that is to be 00673 converted to ansi. 00674 00675 BytesInUnicodeString - The number of bytes in the the string pointed to by 00676 UnicodeString. 00677 00678 Return Value: 00679 00680 SUCCESS - The conversion was successful 00681 00682 --*/ 00683 00684 { 00685 ULONG TmpCount; 00686 ULONG LoopCount; 00687 ULONG CharsInUnicodeString; 00688 UCHAR SbChar; 00689 WCHAR UnicodeChar; 00690 ULONG i; 00691 00692 // 00693 // Convert Unicode byte count to character count. Byte count of 00694 // multibyte string is equivalent to character count. 00695 // 00696 CharsInUnicodeString = BytesInUnicodeString / sizeof(WCHAR); 00697 00698 LoopCount = (CharsInUnicodeString < MaxBytesInMultiByteString) ? 00699 CharsInUnicodeString : MaxBytesInMultiByteString; 00700 00701 if (ARGUMENT_PRESENT(BytesInMultiByteString)) 00702 *BytesInMultiByteString = LoopCount; 00703 00704 00705 for (i=0;i<LoopCount;i++) { 00706 MultiByteString[i] = (CHAR)UnicodeString[i]; 00707 } 00708 00709 return STATUS_SUCCESS; 00710 00711 } }

WCHAR RtlUpcaseUnicodeChar (  IN WCHAR  SourceCharacter  )

Definition at line 433 of file nlsboot.c. References upcase. : This function translates the specified unicode character to its equivalent upcased unicode chararacter. The purpose for this routine is to allow for character by character upcase translation. The translation is done with respect to the current system locale information. Arguments: SourceCharacter - Supplies the unicode character to be upcased. Return Value: Returns the upcased unicode equivalent of the specified input character. --*/ { return (upcase(SourceCharacter)); }

NTSTATUS RtlUpcaseUnicodeToMultiByteN (  OUT PCH  MultiByteString, IN ULONG  MaxBytesInMultiByteString, OUT PULONG BytesInMultiByteString  OPTIONAL, IN PWCH  UnicodeString, IN ULONG  BytesInUnicodeString )

Definition at line 506 of file nlsboot.c. References RtlUpcaseUnicodeChar(). : This functions upper cases the specified unicode source string and converts it into an ansi string. The translation is done with respect to the ANSI Code Page (ACP) loaded at boot time. Arguments: MultiByteString - Returns an ansi string that is equivalent to the upper case of the unicode source string. If the translation can not be done, an error is returned. MaxBytesInMultiByteString - Supplies the maximum number of bytes to be written to MultiByteString. If this causes MultiByteString to be a truncated equivalent of UnicodeString, no error condition results. BytesInMultiByteString - Returns the number of bytes in the returned ansi string pointed to by MultiByteString. UnicodeString - Supplies the unicode source string that is to be converted to ansi. BytesInUnicodeString - The number of bytes in the the string pointed to by UnicodeString. Return Value: SUCCESS - The conversion was successful --*/ { ULONG TmpCount; ULONG LoopCount; ULONG CharsInUnicodeString; UCHAR SbChar; WCHAR UnicodeChar; ULONG i; // // Convert Unicode byte count to character count. Byte count of // multibyte string is equivalent to character count. // CharsInUnicodeString = BytesInUnicodeString / sizeof(WCHAR); LoopCount = (CharsInUnicodeString < MaxBytesInMultiByteString) ? CharsInUnicodeString : MaxBytesInMultiByteString; if (ARGUMENT_PRESENT(BytesInMultiByteString)) *BytesInMultiByteString = LoopCount; for (i=0;i<LoopCount;i++) { MultiByteString[i] = (UCHAR)RtlUpcaseUnicodeChar((UCHAR)(UnicodeString[i])); } return STATUS_SUCCESS; }

---