UniLocaleStrToToken: Difference between revisions

Latest revision as of 18:49, 26 July 2017

Converts a locale specific string to a token.

Syntax

UniStrToToken(localeStrType, localeStr, result) ;

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 Convention

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 1: / Line 1: @@
-== UniStrToToken ==
+Converts a locale specific string to a token.
-; UniStrToToken(localeStrType, localeStr, result) : Converts a locale specific string to a token.
+=== Syntax ===
+ UniStrToToken(localeStrType, localeStr, result) ;
 === 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 ===
 An integer with values of:
-* [[OS2 API:Unicode:error#ULS_OTHER|ULS_OTHER]]
+* [[Unicode Errors#ULS_OTHER|ULS_OTHER]]
-* [[OS2 API:Unicode:error#ULS_SUCCESS|ULS_SUCCESS]]
+* [[Unicode Errors#ULS_SUCCESS|ULS_SUCCESS]]
-* [[OS2 API:Unicode:error#ULS_UNSUPPORTED|ULS_UNSUPPORTED]]
+* [[Unicode Errors#ULS_UNSUPPORTED|ULS_UNSUPPORTED]]
-=== Module ===
+=== Calling Convention ===
-=== Define (C/C++) ===
-=== Export name/Ordinal ===
-=== Calling conversion ===
 [[Cdecl32]]
 === 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 33: @@
 === 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]]