IltmmCapture::get_TargetFile

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_get_TargetFile(pCapture, pCaptureFile)

C++ Syntax

HRESULT get_TargetFile(pCaptureFile)

IltmmCapture *pCapture;

pointer to an interface

BSTR *pCaptureFile;

pointer to a string

Retrieves the target file name.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

pCaptureFile

Pointer to a character string to be updated with the target file name.

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

This function returns the string assigned with the put_TargetFile function. Please note that if the target format type, set using IltmmCapture::put_TargetFormat, is ltmmCapture_TargetFormat_DVD, then pVal will be updated with the full path to the directory in which the DVD image is located.

If the method succeeds, the caller must free the returned BSTR by calling the SysFreeString 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

See Also

Elements:

IltmmCapture::get_TargetType, IltmmCapture::put_TargetFile, IltmmCapture::ResetTarget

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++.

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help