Syntax

   #include <nunicode.h> 
    
   N_EXTERN_LIBRARY(nint) NWUXUnicodeToByte  ( 
      pCONVERT               byteUniHandle,  
      pnuint8                byteOutput,  
      nuint                  outputBufferLen,  
      const unicode N_FAR   *unicodeInput,  
      pnuint                 actualLength);
   

Pascal Syntax

   uses netwin32 
    
   Function NWUXUnicodeToByte 
     (byteUniHandle : pCONVERT;
     byteOutput : pnuint8;
     outputBufferLen : nuint
     unicodeInput : const unicode
     actualLength : pnuint
   ): nint;
   

Parameters

byteUniHandle

(IN) Points to the Unicode converter handle.

byteOutput

(OUT) Points to the output buffer to receive the converted byte 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 converted.

actualLength

(OUT) Points to the returned length (in bytes) of the converted string (optional). Does not include the NULL terminator.

Return Values

Remarks

By default, NWUXUnicodeToByte converts an unmappable Unicode character into a special 6-byte sequence. For example, 0x2620 is converted to "[2620]".

By default, NWUXUnicodeToByte does not recognize any special Unicode sequences for conversion. For example, the Unicode string "ab[81]cd" will be returned as the byte string "ab[81]cd".

Call NWUXUnicodeToByte to determine the size of the string before it is converted by setting the byteOutput 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 exunib.c for sample code.

See Also

NWUXUnicodeToBytePath, NWUXUnicodeToCase