IPXV_Inst::GetCurrentUILang Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 12: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;ppLangCode
 
;ppLangCode
:[out, retval]  Return pointer to unicode string that will contain language identifier in format <langID>-<countryID>. For example:
+
:[out, retval]  Return pointer to unicode string that will contain language identifier in format "langID-countryID". For example:
 
::<tt>en-us // English - US</tt>
 
::<tt>en-us // English - US</tt>
 
::<tt>en-au // English - Australia</tt>
 
::<tt>en-au // English - Australia</tt>
 
::<tt>en-gb // English - Great Britain</tt>
 
::<tt>en-gb // English - Great Britain</tt>
 +
Also the special value <tt>-</tt> (Hyphen-Minus) - means that built-in (English US) language is selected in UI.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 18:00, 24 May 2015


Returns the identifier of current UI-language.

Syntax

HRESULT GetCurrentUILang([out, retval]  BSTR*  ppLangCode);

Parameters

ppLangCode
[out, retval] Return pointer to unicode string that will contain language identifier in format "langID-countryID". For example:
en-us // English - US
en-au // English - Australia
en-gb // English - Great Britain

Also the special value - (Hyphen-Minus) - means that built-in (English US) language is selected in UI.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst