IltmmVideoFormat::put_Selected

#include "ltmm.h"

C Syntax

HRESULT IltmmVideoFormat__put_Selected(pVideoFormat, newVal)

C++ Syntax

HRESULT put_Selected(newVal)

 

IltmmVideoFormat *pVideoFormat;

/* pointer to an interface */

VARIANT_BOOL newVal;

/* flag */

Specifies whether the video format is currently selected.

Parameter

Description

pVideoFormat

Pointer to an IltmmVideoFormat Interface.

newVal

Flag that specifies whether the video format is selected. Possible values are:

 

Value

Description

 

VARIANT_TRUE

Set this video format as the current selection.

 

VARIANT_FALSE

No effect.

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

Call IltmmVideoFormat::get_Selected to retrieve the current video format selection status.

If the format is currently selected, changing its selection state will have no effect. One format must be selected at any time.

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:

IltmmVideoFormat Interface, IltmmVideoFormat::get_Selected

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmVideoFormats::get_Count Example for C.

For a C++ example, refer to IltmmVideoFormats::get_Count Example for C++.