IltmsErrorInformation::GetErrorDescription

#include "ltms.h"

C Syntax

HRESULT IltmsErrorInformation_GetErrorDescription(pErrorInformation, code, description)

C++ Syntax

HRESULT GetErrorDescription(code, description)

IltmsErrorInformation pErrorInformation;

pointer to an interface

SCODE code;

error code

BSTR description;

pointer to a string

Retrieves a text description for an LTMS error code.

Parameter

Description

pErrorInformation

Pointer to an IltmsErrorInformation interface.

code

HRESULT error code for which to get the error description.

description

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

Returns

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 method succeeds, free the returned BSTR by calling the SysFreeString function.

Required DLLs and Libraries

LTMS

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:

IltmsErrorInformation Interface

Topics:

Media Streaming Function Groups  
Using the ltmsErrorInformation Object to Get Extended Error Information

Example

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

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

LEADTOOLS Media Streaming C API Help