In This Topic ▼

IltmmCapture::put_TargetFile

Summary

Sets the media target to a file.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmCapture_put_TargetFile(pCapture, CaptureFile)
C++	HRESULT put_TargetFile(CaptureFile)

Parameters

IltmmCapture *pCapture

Pointer to an IltmmCapture interface.

BSTR CaptureFile

Character string that contains the receive the media data file name.

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

This function allows the user to set the output of the capturing process to the specified file name. If the target format set using IltmmCapture::put_TargetFormat is ltmmCapture_TargetFormat_DVD, then the newVal parameter contains the directory in which the DVD image is located. Otherwise, newVal contains the name of a media file. If the newVal parameter refers to a directory, it should contain the full path to the directory. A relative path can be used, but it is not recommended because relative paths are somewhat unpredictable. If the target format type is ltmmCapture_TargetFormat_DVD and newVal contains the name of an existing file, that file will be deleted, and a directory/folder will be created with the same name.

The filename can be used to indicate a regular file or a stream.

The ResetTarget function should be called to stop the capture object from accessing the file or stream. The TargetType will be set to ltmmCapture_Target_File.

For more details on the filename syntax, refer to TargetFile syntax.