UniQueryLocaleInfo: Difference between revisions

Revision as of 17:53, 12 March 2018

Get information about the locale conventions.

Syntax

UniQueryLocaleInfo(localeObj, result)

Parameters

localeObj - LocaleObject - input: The locale object created from UniCreateLocaleObject.
result - UniLconv - output: The item to hold the locale conventions information.

Constants

None

Returns

An integer with values of:

Module

Define (C/C++)

Export name/Ordinal

Calling Convention

Cdecl32

Example Code

LocaleObject localeObj;
UniLconv     result;
integer      rc;
...
rc = UniQueryLocaleInfo(localeObj, result);
...

Related Functions

UniFreeLocaleInfo

Notes

'UniQueryLocaleInfo returns information from the localeObj and places information in the UniLconv structure. UniQueryLocaleInfo allocates the memory to hold the UniLconv structure. The application must free the memory using UniFreeLocaleInfo when the structure is no longer needed. The UniLconv structure is filled using the locale provided by localeObj.

OS Version Introduced

OS/2 Warp

@@ Line 2: / Line 2: @@
 === Syntax ===
-  UniQueryLocaleInfo(localeObj, result) ;
+  UniQueryLocaleInfo(localeObj, result)
 === Parameters ===
-; localeObj - [[OS2 API:DataType:LocaleObject|LocaleObject]] - input : The locale object created from [[OS2_API:UniCreateLocaleObject|UniCreateLocaleObject]].
+;localeObj - [[LocaleObject]] - input : The locale object created from [[UniCreateLocaleObject]].
-; result - [[OS2 API:DataType:UniLconv|UniLconv]] - output : The item to hold the locale conventions information.
+;result - [[UniLconv]] - output : The item to hold the locale conventions information.
 === Constants ===
@@ Line 26: / Line 26: @@
 === Example Code ===
-  [[OS2 API:DataType:LocaleObject|LocaleObject]] localeObj;
+  LocaleObject localeObj;
-  [[OS2 API:DataType:UniLconv|UniLconv]]     result;
+  UniLconv     result;
   integer      rc;
   ...
@@ Line 34: / Line 34: @@
 === Related Functions ===
-[[OS2 API:UniFreeLocaleInfo|UniFreeLocaleInfo]]
+*[[UniFreeLocaleInfo]]
 === Notes ===
-[[OS2 API:UniQueryLocaleInfo|UniQueryLocaleInfo]] returns information from the localeObj and places information in the [[OS2 API:DataType:UniLconv|UniLconv]] structure. [[OS2 API:UniQueryLocaleInfo|UniQueryLocaleInfo]] allocates the memory to hold the [[OS2 API:DataType:UniLconv|UniLconv]] structure.  The application '''must''' free the memory using [[OS2 API:UniFreeLocaleInfo|UniFreeLocaleInfo]] when the structure is no longer needed.  The [[OS2 API:DataType:UniLconv|UniLconv]] structure is filled using the locale provided by localeObj.
+'''UniQueryLocaleInfo'' returns information from the localeObj and places information in the [[UniLconv]] structure. ''UniQueryLocaleInfo'' allocates the memory to hold the [[UniLconv]] structure. The application '''must''' free the memory using ''UniFreeLocaleInfo'' when the structure is no longer needed. The ''UniLconv'' structure is filled using the locale provided by localeObj.
 === OS Version Introduced ===