IltmmTargetFormat::get_Sink

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetFormat__get_Sink(pTargetFormat, pVal)

C++ Syntax

HRESULT get_Sink(pVal)

 

IltmmTargetFormat *pTargetFormat;

/* pointer to an interface */

BSTR *pVal;

/* pointer to a string */

Retrieves the sink's name.

Parameter

Description

pTargetFormat

Pointer to an IltmmTargetFormat interface.

pVal

Pointer to a variable that receives a string containing the sink's 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

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:

IltmmTargetFormat::get_Name

Topics:

Multimedia Function Group

Example

For an example, refer to Selecting ltmmCapture Object TargetFormats for C.

For an example, refer to Selecting ltmmCapture Object TargetFormats for C++.

For an example, refer to Selecting ltmmConvert Object TargetFormats for C.

For an example, refer to Selecting ltmmConvert Object TargetFormats for C++.