UniStrToUcs: Difference between revisions
m major IBM documentation mistakes |
mNo edit summary |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== | Convert a code page string to a UCS string. | ||
===Syntax=== | |||
UniStrToUcs(uconvObj, ucsBuffer, inBuffer, ucsBufferLen); | |||
=== Parameters === | === Parameters === | ||
; uconvObj - [[ | ;uconvObj - [[UconvObject]] - input : The conversion object created from [[UniCreateUconvObject]]. | ||
; ucsBuffer - [[ | ;ucsBuffer - [[UniChar]] - output : The ucs buffer. | ||
; inBuffer - (character) - input : The input buffer that is null terminated. | ;inBuffer - (character) - input : The input buffer that is null terminated. | ||
; ucsBufferLen - (integer) - input : Number of unicode character elements in the ucsBuffer. | ;ucsBufferLen - (integer) - input : Number of unicode character elements in the ucsBuffer. | ||
<!-- | <!-- | ||
; inBufferLen - (size_t *) - input/output : The input buffer's length, in bytes. | ;inBufferLen - (size_t *) - input/output : The input buffer's length, in bytes. | ||
; nonIdenticalConv - (size_t *) - output : Number of non-identical conversions. | ;nonIdenticalConv - (size_t *) - output : Number of non-identical conversions. | ||
--> | --> | ||
=== Returns === | === Returns === | ||
An integer with values of: | An integer with values of: | ||
* [[ | * [[Unicode Errors#ULS_BADOBJECT|ULS_BADOBJECT]] | ||
* [[ | * [[Unicode Errors#ULS_BUFFERFULL|ULS_BUFFERFULL]] | ||
* [[ | * [[Unicode Errors#ULS_ILLEGALSEQUENCE|ULS_ILLEGALSEQUENCE]] | ||
* [[ | * [[Unicode Errors#ULS_INVALID|ULS_INVALID]] | ||
* [[ | * [[Unicode Errors#ULS_SUCCESS|ULS_SUCCESS]] | ||
=== Calling | === Calling Convention === | ||
[[Cdecl32]] | [[Cdecl32]] | ||
=== Example Code === | === Example Code === | ||
<code> | |||
[[ | character inBuffer = "C:\SOMEPATH\FILE.TXT"; | ||
size_t unicodeBuffLen = 12; | |||
ULONG codePage; | |||
ULONG cpLen; // length set by [[DosQueryCp]] | |||
UniChar unicodeBuff, // length of unicodeBuffLen | |||
ucsBuffer; // length of CCHMAXPATH | |||
UconvObject uconvObj; | |||
character out; // allocate to CCHMAXPATH | |||
integer rc; | integer rc; | ||
rc = UniStrToUcs(uconvObj, ucsBuffer, inBuffer, | rc = DosQueryCp(size of ULONG, codePage, cpLen); | ||
/* determine string for the conversion of codePage */ | |||
=== | rc = UniMapCpToUcsCp(codePage, unicodeBuff, unicodeBuffLen); | ||
rc = UniCreateUconvObject(unicodeBuff, uconvObj); | |||
rc = UniStrToUcs(uconvObj, ucsBuffer, inBuffer, CCHMAXPATH); | |||
rc = UniFreeUconvObject(uconvObj); | |||
/* conversion for current codepage that can be used for paths */ | |||
rc = UniCreateUconvObject((UniChar pointer)L"@path=yes", uconvObj); | |||
rc = UniStrFromUcs(uconvObj, out, ucsBuffer, CCHMAXPATH); | |||
rc = UniFreeUconvObject(uconvObj); | |||
/* use out - don't forget to de-allocate out when finished with it. */ | |||
/* error checking left out for brevity */ | |||
</code> | |||
=== Notes === | === Notes === | ||
The sequence of the code page characters in inBuffer is converted into a sequence of Unicode characters in ucsBuffer. | The sequence of the code page characters in inBuffer is converted into a sequence of Unicode characters in ucsBuffer. The code page was set by [[UniCreateUconvObject]] call in the [[UconvObject]]. | ||
Conversion is only on bytes that convert. | Conversion is only on bytes that convert. The process stops converting on the first non-valid byte. If the ucsBuffer isn't large enough, conversion ends on the byte previous to any buffer overflow. inBuffer is updated truncating the point of failure to the end and updating the ucsBufferLen to indicate the number of successfully converted elements. | ||
=== OS Version Introduced === | === OS Version Introduced === | ||
OS/2 Warp | OS/2 Warp | ||
== Related Functions == | |||
*[[UniUconvFromUcs]] | |||
*[[UniUconvToUcs]] | |||
*[[UniStrFromUcs]] | |||
[[Category:Uni]] | |||
Latest revision as of 18:01, 4 December 2019
Convert a code page string to a UCS string.
Syntax
UniStrToUcs(uconvObj, ucsBuffer, inBuffer, ucsBufferLen);
Parameters
- uconvObj - UconvObject - input
- The conversion object created from UniCreateUconvObject.
- ucsBuffer - UniChar - output
- The ucs buffer.
- inBuffer - (character) - input
- The input buffer that is null terminated.
- ucsBufferLen - (integer) - input
- Number of unicode character elements in the ucsBuffer.
Returns
An integer with values of:
Calling Convention
Example Code
character inBuffer = "C:\SOMEPATH\FILE.TXT";
size_t unicodeBuffLen = 12;
ULONG codePage;
ULONG cpLen; // length set by DosQueryCp
UniChar unicodeBuff, // length of unicodeBuffLen
ucsBuffer; // length of CCHMAXPATH
UconvObject uconvObj;
character out; // allocate to CCHMAXPATH
integer rc;
rc = DosQueryCp(size of ULONG, codePage, cpLen);
/* determine string for the conversion of codePage */
rc = UniMapCpToUcsCp(codePage, unicodeBuff, unicodeBuffLen);
rc = UniCreateUconvObject(unicodeBuff, uconvObj);
rc = UniStrToUcs(uconvObj, ucsBuffer, inBuffer, CCHMAXPATH);
rc = UniFreeUconvObject(uconvObj);
/* conversion for current codepage that can be used for paths */
rc = UniCreateUconvObject((UniChar pointer)L"@path=yes", uconvObj);
rc = UniStrFromUcs(uconvObj, out, ucsBuffer, CCHMAXPATH);
rc = UniFreeUconvObject(uconvObj);
/* use out - don't forget to de-allocate out when finished with it. */
/* error checking left out for brevity */
Notes
The sequence of the code page characters in inBuffer is converted into a sequence of Unicode characters in ucsBuffer. The code page was set by UniCreateUconvObject call in the UconvObject.
Conversion is only on bytes that convert. The process stops converting on the first non-valid byte. If the ucsBuffer isn't large enough, conversion ends on the byte previous to any buffer overflow. inBuffer is updated truncating the point of failure to the end and updating the ucsBufferLen to indicate the number of successfully converted elements.
OS Version Introduced
OS/2 Warp