IPXV_Inst::GetTextFromHRes Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetTextFromHRes Method}}
 
{{#customTitle:IPXV_Inst::GetTextFromHRes Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|GetTextFromHRes|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets description of the code value.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetTextFromHRes([in] HRESULT hRes, [in, defaultvalue(0)] VARIANT_BOOL bShort, [out, retval] BSTR* ppText);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetTextFromHRes([in]                   HRESULT       hRes,
 +
                        [in, defaultvalue(0)] VARIANT_BOOL bShort,
 +
                        [out, retval]         BSTR*         ppText);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''hRes''
+
;hRes
:[in]  Value of HRESULT.
+
:[in]  The code value.
;''bShort''
+
;bShort
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Controls what type of description should be in output: long or short.
;''ppText''
+
;ppText
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Returns text of description.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 15:28, 25 May 2015


Gets description of the code value.

Syntax

HRESULT GetTextFromHRes([in]                   HRESULT       hRes,
                        [in, defaultvalue(0)]  VARIANT_BOOL  bShort,
                        [out, retval]          BSTR*         ppText);

Parameters

hRes
[in] The code value.
bShort
[in, defaultvalue(0)] Controls what type of description should be in output: long or short.
ppText
[out, retval] Returns text of description.

Return Value

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

See Also

IPXV_Inst