Retrieves a text description for an LTMS error code.
#include "ltms.h"
Language | Syntax |
---|---|
C | HRESULT IltmsErrorInformation_GetErrorDescription(pErrorInformation, code, description) |
C++ | HRESULT GetErrorDescription(code, description) |
Pointer to an IltmsErrorInformation interface.
HRESULT error code for which to get the error description.
Pointer to a variable that receives a character string containing the description for the specified error code.
Value | Meaning |
---|---|
S_OK | The function was successful. |
<> S_OK | An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation. |
This function will return a string containing the description of the error.
If the function succeeds, free the returned BSTR by calling the SysFreeString function.
Win32, x64.
For a C++ example, refer to Get Error Description Example for C++.