IAUX_Inst::FormatHRESULT Method

From Tracker Software PDF SDK
Revision as of 22:31, 5 July 2016 by Palamar (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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