IltmmTargetFormats::Add

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetFormats_Add(pTargetFormats, Name, Index)

C++ Syntax

HRESULT Add(Name, Index)

 

IltmmTargetFormats *pTargetFormats;

/* pointer to an interface */

BSTR Name;

/* string */

long Index;

/* index */

Adds a format to the collection.

Parameter

Description

pTargetFormats

Pointer to an IltmmTargetFormats interface.

Name

Character string containing the name of the new format.

Index

Zero based index of the position to insert the format. A value of –1 appends to end of the collection.

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.

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.

Comments

The user should retrieve the item's interface to define the individual properties of the format.

The user may not insert a format before a predefined (ReadOnly) format. Check the initial get_Count value to determine the end of the predefined list.

See Also

Elements:

IltmmTargetFormats::Item, IltmmTargetFormats::get_Count, IltmmTargetFormat Interface

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