IltmsErrorInformation::GetErrorDescription

Summary

Retrieves a text description for an LTMS error code.

Syntax

#include "ltms.h"

Language Syntax
C HRESULT IltmsErrorInformation_GetErrorDescription(pErrorInformation, code, description)
C++ HRESULT GetErrorDescription(code, description)

Parameters

IltmsErrorInformation *pErrorInformation

Pointer to an IltmsErrorInformation interface.

SCODE code

HRESULT error code for which to get the error description.

BSTR* description

Pointer to a variable that receives a character string containing the description for the specified error code.

Returns

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.

Comments

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.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For a C++ example, refer to Get Error Description Example for C++.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Streaming C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.