NWUXUnicodeToCase

Converts a NULL-terminated Unicode string to upper case, lower case, or title case, depending on the converter pointed to

Local Servers:nonblocking
Remote Servers:N/A
NetWare Server:4.x, 5.x, 6.x
Platform:NLM, Windows NT, Windows95, Windows 98
Library:Cross-Platform Localization (LOC*.*)
Service:Unicode

Syntax

   #include <nunicode.h> 
    
   N_EXTERN_LIBRARY(nint) NWUXUnicodeToCase  ( 
      pCONVERT               caseHandle,  
      punicode               monocasedOutput,  
      nuint                  outputBufferLen,  
      const unicode N_FAR   *unicodeInput,  
      pnuint                 actualLength);
   

Pascal Syntax

   uses netwin32 
    
   Function NWUXUnicodeToCase 
     (caseHandle : pCONVERT;
     monocasedOutput : punicode;
     outputBufferLen : nuint
     unicodeInput : const unicode
     actualLength : pnuint
   ): nint;
   

Parameters

caseHandle
(IN) Points to the monocase converter handle.
monocaseOutput
(OUT) Points to the output buffer to receive the converted Unicode string (optional).
outputBufferLen
(IN) Specifies the maximum size of the output buffer in bytes (0 specifies that the buffer size is not checked).
unicodeInput
(IN) Points to the input buffer containing the Unicode string to be monocased.
actualLength
(OUT) Points to the returned length (in Unicode characters) of the converted string (optional). Does not include the NULL terminator.

Return Values

0x0000

SUCCESSFUL

0xFDE9

NWU_NULL_HANDLE

0xFDEA

NWU_BAD_HANDLE

0xFDEB

NWU_HANDLE_MISMATCH

0xFDEE

NWU_BUFFER_FULL

Remarks

The caseHandle parameter points to the converter to be used. The type of converter is specified when the converter is loaded with the NWUXLoadCaseConverter function.

Lower case conversions are preferred for most operations since there are more lower case than upper case characters in Unicode.

There are Unicode characters that may result in two or more Unicode characters when converted. Do not use the same buffer for both input and output strings.

Input characters that have no case are unaffected.

Call NWUXUnicodeToCase to determine the size of the string before it is converted by setting the monocasedOutput parameter to NULL. The outputBufferLen parameter will be ignored, a converted string will not be returned, and the length of the string if it were converted will be returned in the actualLength parameter.

See exucase.c for sample code.

See Also

NWUXLoadCaseConverter