IltmmTargetFormat::put_Sink

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetFormat__put_Sink(pTargetFormat, newVal)

C++ Syntax

HRESULT put_Sink(newVal)

 

IltmmTargetFormat *pTargetFormat;

/* pointer to an interface */

BSTR newVal;

/* string */

Assigns the sink's name.

Parameter

Description

pTargetFormat

Pointer to an IltmmTargetFormat interface.

newVal

Character 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

This function assigns the multiplexer A module that combines audio and video into one file.. When the format is selected, the output from the multiplexer is directly connected to this filter. If the value is undefined (empty string), then an appropriate sink will be created based upon the type of target selected.

Attempting to set this value on a ReadOnly item will result in an error.

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