IAppCfg::DecodeStatusCode Method [C++]

Article
11/12/2009

Use this method to decode the specified status code.

Definition

[C++]

HRESULT IAppCfg::DecodeStatusCode(intiStatusCode,
  BSTR*pbstrStatusCode);

[Visual Basic]

Function DecodeStatusCode(iStatusCode As Integer) As String

Parameters

iStatusCode[C++]
[in] An integer that specifies the status code to be decoded.
iStatusCode[Visual Basic]
An Integer that specifies the status code to be decoded.
pbstrStatusCode[C++]
[out, retval] The address of a BSTR used to return the decoded status code. If the specified status code is not in the system, that same status code is returned.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a String that contains the decoded status code. If the specified status code is not in the system, that same status code is returned.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The pbstrStatusCode parameter contains valid data only if the method returns successfully.

Status codes are entered in the Commerce Server Business Desk.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.