IltmmCapture::IsModeAvailable

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_IsModeAvailable(pCapture, Mode, pAvailable)

C++ Syntax

HRESULT IsModeAvailable(Mode, pAvailable)

 

IltmmCapture *pCapture;

/* pointer to an interface */

long Mode;

/* mode value */

VARIANT_BOOL pAvailable;

/* flag */

Queries whether the specified capture mode is available.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

Mode

Value that specifies which capture mode's availablity is being queried. Must be one of the ltmmCapture_Mode Constants.

pAvailable

Pointer to a variable that determines whether the specified capture mode is available. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

Specified capture mode is available.

 

VARIANT_FALSE

Specified capture mode is unavailable.

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 is useful for determining whether all the components, necessary for a particular capture mode, have been initialized.

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.

See Also

Elements:

IltmmCapture::ReadyCapture, IltmmCapture::StartCapture, ltmmCapture_Mode Constants

Topics:

Multimedia Function Group

Example

For a C example, refer to Advanced Capture Application for C.

For a C++ example, refer to Advanced Capture Application for C++.