UniLocaleStrToToken: Difference between revisions

← Older edit Newer edit →

Revision as of 04:23, 5 December 2016

UniStrToToken

UniStrToToken(localeStrType, localeStr, result): Converts a locale specific string to a token.

Parameters

localeStrType - integer - input: The type of string being given to this function.
localeStr - PVOID - input: The locale specific string.
result - LocaleToken - output: The result of the conversion to a token.

Constants

Used for the parameter localeStrType:

Returns

An integer with values of:

Calling conversion

Cdecl32

Example Code

integer     localeStrType;
PVOID       localeStr;
LocaleToken result;
integer     rc;
...
rc = UniLocaleStrToToken(localeStrType, localeStr, result);
...

Related Functions

UniLocaleTokenToStr

Notes

This function allocates the memory for the locale token. If no locale token exists for the given locale string, the result is undefined for the locale token.

OS Version Introduced

OS/2 Warp

@@ Line 4: / Line 4: @@
 === Parameters ===
 ; localeStrType - integer - input : The type of string being given to this function.
-; localeStr - [[OS2 API:DataType:PVOID|PVOID]] - input : The locale specific string.
+; localeStr - [[PVOID]] - input : The locale specific string.
-; result - [[OS2 API:DataType:LocaleToken|LocaleToken]] - output : The result of the conversion to a token.
+; result - [[LocaleToken]] - output : The result of the conversion to a token.
 === Constants ===
 Used for the parameter localeStrType:
-* [[OS2 API:Constant:UNI#UNI_MBS_STRING_POINTER|UNI_MBS_STRING_POINTER]]
+* [[UNI#UNI_MBS_STRING_POINTER|UNI_MBS_STRING_POINTER]]
-* [[OS2 API:Constant:UNI#UNI_UCS_STRING_POINTER|UNI_UCS_STRING_POINTER]]
+* [[UNI#UNI_UCS_STRING_POINTER|UNI_UCS_STRING_POINTER]]
 === Returns ===
@@ Line 17: / Line 17: @@
 * [[OS2 API:Unicode:error#ULS_SUCCESS|ULS_SUCCESS]]
 * [[OS2 API:Unicode:error#ULS_UNSUPPORTED|ULS_UNSUPPORTED]]
-=== Module ===
-=== Define (C/C++) ===
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 29: / Line 23: @@
 === Example Code ===
   integer     localeStrType;
-  [[OS2 API:DataType:PVOID|PVOID]]       localeStr;
+  PVOID       localeStr;
-  [[OS2 API:DataType:LocaleToken|LocaleToken]] result;
+  LocaleToken result;
   integer     rc;
   ...
@@ Line 37: / Line 31: @@
 === Related Functions ===
-[[OS2 API:UniLocaleTokenToStr|UniLocaleTokenToStr]]
+*[[UniLocaleTokenToStr]]
 === Notes ===
-This function allocates the memory for the locale token.  If no locale token exists for the given locale string, the result is undefined for the locale token.
+This function allocates the memory for the locale token. If no locale token exists for the given locale string, the result is undefined for the locale token.
 === OS Version Introduced ===
 OS/2 Warp
+[[Category:Uni]]
-[[OS2_API | Back to OS/2 API]]
-[[Category:The OS/2 API Project]]