Syntax

   #include <nunicode.h> 
    
   N_EXTERN_LIBRARY(nint) NWUSByteToUnicode (
      punicode              unicodeOutput,  
      nuint                 outputBufferLen,  
      const nuint8 N_FAR   *byteInput,  
      pnuint                actualLength);
   

Pascal Syntax

   uses netwin32 
    
   Function NWUSByteToUnicode 
     (unicodeOutput : punicode;
     outputBufferLen : nuint;
     byteInput : const nuint8;
     actualLength : pnuint              
   ): nint;
   

Parameters

unicodeOutput

(OUT) Points to the output buffer to receive the resulting Unicode string (optional).

outputBufferLen

(IN) Specifies the maximum size of the output buffer in Unicode characters.

byteInput

(IN) Points to the input buffer containing the byte text to be converted.

actualLength

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

Return Values

Remarks

Call NWUSByteToUnicodePath whenever the byte string to be converted is a file path.

NWUSByteToUnicode converts an unmappable byte into the substitute Unicode character.

NWUSByteToUnicode converts a special byte sequence into a Unicode character. For example, "[2620]" is converted to the single Unicode character, 0x2620.

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

See Also

NWUSByteToUnicodePath