In This Topic ▼

IltmmConvert::GetClosedCaptioningTargetFile

Summary

Retrieves the filename and flags set using the IltmmConvert::SetClosedCaptioningTargetFile method.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmConvert_GetClosedCaptioningTargetFile(pConvert, filename, pFlags)
C++	HRESULT GetClosedCaptioningTargetFile(filename, pFlags)

Parameters

IltmmConvert *pConvert

Pointer to an IltmmConvert interface.

BSTR *filename

Pointer to a string to be updated with the filename to which the closed captioning information will be saved.

long *pFlags

Pointer to a long value to be updated with save flags. For a list of possible values, refer to ltmmClosedCaptioning_Flag constants.

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

Retrieves the filename and flags set by the IltmmConvert::SetClosedCaptioningTargetFile method. If no filename has been set It returns NULL and zero flags. If a filename has been set and it returns zero flags it means that it is set to save closed captioning information as an SRT file.

If the method succeeds, free the returned string by calling the SysFreeString function.

For more information, refer to IltmmConvert::SetClosedCaptioningTargetFile.