IltmsErrorInformation::GetErrorDescription

Summary

Retrieves a text description for an LTMS error code.

Syntax

#include "ltms.h"

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

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

• 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

Functions

• 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++.