Share via


IAdminEventLog::WriteErrorEvent Method

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Use this method to write an error event to the Commerce Server event log.

HRESULT IAdminEventLog::WriteErrorEvent(
    BSTR bstrSiteName,
    BSTR bstrMessage
);
Sub WriteErrorEvent(
    String bstrSiteName,
    String bstrMessage
)

Parameters

  • bstrSiteName
    [C++]

    [in] A BSTR that contains the site name.

    [Visual Basic]

    A String that contains the site name.

  • bstrMessage
    [C++]

    [in] A BSTR that contains the error event message string.

    [Visual Basic]

    A String that contains the error event message string.

Return Value

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

[Visual Basic] None.

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.

Example

' oAdminEventLog is a AdminEventLog object.

oAdminEventLog.WriteErrorEvent("MySite", _
                               "Database does not exist")

See Also

Other Resources

AdminEventLog Object