IAUX_Inst::FormatHRESULT Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAUX_Inst::FormatHRESULT Method}}
 
{{#customTitle:IAUX_Inst::FormatHRESULT Method}}
{{#parentPage:PXV:IAUX_Inst|FormatHRESULT Method|method}}
+
{{#parentPage:PXV:IAUX_Inst#Methods|FormatHRESULT|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Formats the result string.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT FormatHRESULT([in]                  HRESULT  nErrCode,
 
<pre class="brush:cpp;gutter:false">HRESULT FormatHRESULT([in]                  HRESULT  nErrCode,
 
                       [in, defaultvalue(0)]  ULONG    nFlags,
 
                       [in, defaultvalue(0)]  ULONG    nFlags,
                       [out, retval]          BSTR*    ppRes);</pre>
+
                       [out, retval]          BSTR*    sRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nErrCode
 
;nErrCode
:[in]  Value of HRESULT.
+
:[in]  Value of HRESULT containing the result code that needs to be formatted.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the formatting flags (can be ''1'' or ''0''). If ''1'' was specified then the short formatting will be used. If ''0'' was specified then full formatting will be used (this will add the "<Severity> [<Facility>]: " prefix).
;ppRes
+
;sRes
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Pointer to BSTR containing the formatted result string.
  
 
== Return Value ==
 
== Return Value ==
Line 24: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IAUX_Inst|IAUX_Inst]].
+
[[PXV:IAUX_Inst|IAUX_Inst]]

Latest revision as of 23:31, 5 July 2016


Formats the result string.

Syntax

HRESULT FormatHRESULT([in]                   HRESULT  nErrCode,
                      [in, defaultvalue(0)]  ULONG    nFlags,
                      [out, retval]          BSTR*    sRes);

Parameters

nErrCode
[in] Value of HRESULT containing the result code that needs to be formatted.
nFlags
[in, defaultvalue(0)] Value of ULONG containing the formatting flags (can be 1 or 0). If 1 was specified then the short formatting will be used. If 0 was specified then full formatting will be used (this will add the "<Severity> [<Facility>]: " prefix).
sRes
[out, retval] Pointer to BSTR containing the formatted result string.

Return Value

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

See Also

IAUX_Inst