IPXV_Inst::GetCurrentUILang Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetCurrentUILang Method}}
 
{{#customTitle:IPXV_Inst::GetCurrentUILang Method}}
{{#parentPage:PXV:IPXV_Inst#Methods|GetCurrentUILang Method|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|GetCurrentUILang|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns the identifier of current UI-language.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetCurrentUILang([out, retval]  BSTR*  ppLangCode);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetCurrentUILang([out, retval]  BSTR*  sLangCode);</pre>
  
 
== Parameters ==
 
== Parameters ==
;ppLangCode
+
;sLangCode
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Return pointer to unicode string that will contain language identifier in format "langID-countryID". For example:
 +
::<code>en-us</code> - English - US
 +
::<code>en-au</code> - English - Australia
 +
::<code>en-gb</code> - English - Great Britain
 +
Also the special value <code>-</code> (hyphen-minus letter) means that built-in (English US) language now is selected in UI.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 22:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Inst|IPXV_Inst]]
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_GetUILanguages|IPXV_Inst::GetUILanguages]]

Latest revision as of 03:56, 15 June 2015


Returns the identifier of current UI-language.

Syntax

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

Parameters

sLangCode
[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 letter) means that built-in (English US) language now is selected in UI.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::GetUILanguages