IAMErrorLog::LogError method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The LogError method logs an error. Applications do not need to call this method. It is called internally in response to rendering errors.

Syntax

HRESULT LogError(
       LONG    Severity,
       BSTR    ErrorString,
       LONG    ErrorCode,
       HRESULT hresult,
  [in] VARIANT *pExtraInfo
);

Parameters

Severity

Reserved. Do not use.

ErrorString

String value containing the text of the error.

ErrorCode

Error code.

hresult

The HRESULT value that was returned by the method call that caused the error.

pExtraInfo [in]

Pointer to a VARIANT that contains any additional information about the error.

Return value

Return the value of the hresult parameter.

Remarks

Within this method, do not free the VARIANT pointed to by pExtraInfo. Also, the VARIANT becomes invalid after the method returns, so do not try to reference it later.

Implement this method to return as quickly as possible. Do not make function calls from inside this method that might block program execution. For example, do not call functions that send window messages, block on events, or otherwise might block execution. Doing so could cause the computer to stop responding.

For a list of errors defined by DES, along with the meaning and data type of the VARIANT pointed to by pExtraInfo, see Rendering Errors.

Requirements

See also

IAMErrorLog Interface

Error and Success Codes