IltmmConvert::GetClosedCaptioningTargetFile

#include "ltmm.h"

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

IltmmConvert *pConvert;	/* pointer to an interface */
BSTR* filename;	/* pointer to a BSTR value*/
long* pFlags;	/* pointer to a long value*/

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

Parameter	Description
pConvert	Pointer to an IltmmConvert interface.
filename	Pointer to a string to be updated with the filename to which the closed captioning information will be saved.
pFlags	Pointer to a long value to be updated with save flags. For a list of possible values, refer to ltmmClosedCaptioning_Flag Constants.

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

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.

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

See Also

Elements:	IltmmPlay::get_CloseCaptioning, IltmmPlay::put_CloseCaptioning, IltmmPlay::ToggleCloseCaptioning, IltmmConvert::GetClosedCaptioningTargetFile , IltmmConvert::SetClosedCaptioningTargetFile, IltmmCapture::get_CloseCaptioning, IltmmCapture::get_PreviewingCloseCaption, IltmmCapture::put_CloseCaptioning, IltmmCapture::ToggleCloseCaptioning, IltmmConvert::get_AllowedStreams
Topics:	Multimedia Function Groups
	Closed Captioning

Example

For a C++ example, refer to IltmmConvert::SetClosedCaptioningTargetFile Example for C++.