UniStrFromUcs: Difference between revisions

Newer edit →

Revision as of 06:24, 26 March 2006

UniStrFromUcs

UniStrFromUcs(uconvObj, outBuffer, ucsString, outBufferLen)

Convert a UCS string to a code page string.

Parameters

uconvObj - UconvObject - input

The conversion object created from UniCreateUconvObject.

outBuffer - CHAR - input

The output buffer to hold code page.

ucsString - UniChar - input

Null terminated Unicode string.

outBufferLen - (int) - input/output

The output buffer's length, in bytes.

Constants

None

Returns

An integer with values of:

Module

Define (C/C++)

INCL_???

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

UconvObject uconvObj;
CHAR*       outBuffer;
UniChar     ucsString;
integer     outBufferLen;
APIRET      rc;
...
rc = UniStrFromUcs(uconvObj, outBuffer, ucsString, outBufferLen);
...

Related Functions

UniconvFromUcs UniconvToUcs UniStrToUcs

Notes

The sequence of code elements in ucsString is converted into a sequence of code page characters to outBuffer. The code page was set by UniCreateUnconvObject call in the UconvObject.

If the outBuffer isn't large enough, conversion ends on the byte previous to any buffer overflow. outBuffer is updated truncating the point of failure to the end and updating the outBufferLen to indicate the number of successfully converted bytes.

OS Version Introduced

OS/2 Warp

@@ Line 35: / Line 35: @@
 === Example Code ===
   [[OS2 API:DataType:UconvObject|UconvObject]] uconvObj;
-  [[OS2 API:DataType:CHAR|CHAR]]*      outBuffer;
+  [[OS2 API:DataType:CHAR|CHAR]]*       outBuffer;
   [[OS2 API:DataType:UniChar|UniChar]]     ucsString;
   integer     outBufferLen;
-  [[OS2 API:DataType:APIRET|APIRET]]     rc;
+  [[OS2 API:DataType:APIRET|APIRET]]      rc;
   ...
   rc = UniStrFromUcs(uconvObj, outBuffer, ucsString, outBufferLen);