ltmmGetErrorText

#include "ltmm.h"

C Syntax

BSTR ltmmGetErrorText (errorcode)

C++ Syntax

BSTR ltmmGetErrorText (errorcode)

 

long errorcode;

/* error code */

Gets the error string for the specified error code.

Parameter

Description

errorcode

The HRESULT error code for which to get the error string.

Returns

Returns a character string that contains the error string for the specified error code. The user should call SysFreeString when this string is no longer needed.

Comments

Even though the ltmmGetErrorText function can be called from C and C++, it is not necessary to use it. The standard automation error object is available in these languages when events are fired. Invalid error codes passed to this function will return an "Internal error" message.

Please note that the ltmmGetErrorText function is global (not attached to a particular interface/object). You use this function to get the description string for the error code returned by any object's function.

Required DLLs and Libraries

LTMM

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

Example

For a C example, refer to Recompressing an AVI File for C.

For a C++ example, refer to Recompressing an AVI File for C++.