IltmmAudioFormat::get_Selected

#include "ltmm.h"

C Syntax

HRESULT IltmmAudioFormat_get_Selected(pAudioFormat, pVal)

C++ Syntax

HRESULT get_Selected(pVal)

 

IltmmAudioFormat *pAudioFormat;

/* pointer to an interface */

VARIANT_BOOL *pVal;

/* pointer to a variable */

Determines whether the audio format is currently selected.

Parameter

Description

pAudioFormat

Pointer to an IltmmAudioFormat Interface.

pVal

Pointer to a variable to be updated with a value that indicates whether the format is currently selected.  Possible values are:

 

Value

Description

 

VARIANT_TRUE

The audio format is currently selected.

 

VARIANT_FALSE

The audio format is not currently selected.

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::put_Selected to select the current audio format.

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