IltmmCapture::CopyTarget

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_CopyTarget(pCapture, FileName, AllowEscAbort)

C++ Syntax

HRESULT CopyTarget(FileName, AllowEscAbort)

 

IltmmCapture *pCapture;

/* pointer to an interface */

BSTR FileName;

/* name of the file */

VARIANT_BOOL AllowEscAbort;

/* flag */

Copies the valid media data from the target to the specified file.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

FileName

Character string containing the destination file name. Valid data is copied to this file.

AllowEscAbort

Flag that determines whether pressing the ESC key will abort the copy operation. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

Pressing the ESC key will abort the copy operation.

 

VARIANT_FALSE

Pressing the ESC key will not abort the copy operation.

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

The new file will contain only valid data and therefore can be much shorter than the target. Typically, you will always capture to the same huge pre-allocated target and use this method to copy the data you want to save from each capture to a new file.

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:

IltmmCapture::AllocTarget

Topics:

Multimedia Function Group

Example

For a C example, refer to Advanced Capture Application for C.

For a C++ example, refer to Advanced Capture Application for C++.