IAUX_Inst::FormatHRESULT Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IAUX_Inst::FormatHRESULT Method}} | {{#customTitle:IAUX_Inst::FormatHRESULT Method}} | ||
{{#parentPage:PXV:IAUX_Inst#Methods|FormatHRESULT|method}} | {{#parentPage:PXV:IAUX_Inst#Methods|FormatHRESULT|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Formats the result string. | |
== Syntax == | == Syntax == | ||
| Line 15: | Line 14: | ||
== 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). |
;sRes | ;sRes | ||
| − | :[out, retval] Pointer to BSTR. | + | :[out, retval] Pointer to BSTR containing the formatted result string. |
== Return Value == | == Return Value == | ||
Latest revision as of 22: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.
