IltmmAudioFormat::put_Selected

#include "ltmm.h"

C Syntax

HRESULT IltmmAudioFormat_put_Selected(pAudioFormat, newVal)

C++ Syntax

HRESULT put_Selected(newVal)

 

IltmmAudioFormat *pAudioFormat;

/* pointer to an interface */

VARIANT_BOOL newVal;

/* flag */

Specifies whether the audio format is currently selected.

Parameter

Description

pAudioFormat

Pointer to an IltmmAudioFormat Interface.

newVal

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

 

Value

Description

 

VARIANT_TRUE

Set this audio 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 IltmmAudioFormat::get_Selected to retrieve the current audio 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:

IltmmAudioFormat Interface, IltmmAudioFormat::get_Selected

Topics:

Multimedia Function Group

Example

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

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