IltmmFilterEnum::get_Enable

#include "ltmm.h"

C Syntax

HRESULT IltmmFilterEnum_get_Enable(pInput, Name, pVal)

C++ Syntax

HRESULT get_Enable(Name, pVal)

IltmmFilterEnum *pInput;

pointer to an interface

BSTR Name

string

VARIANT_BOOL *pVal;

pointer to a variable

Retrieves a value that indicates whether the filter is enabled.

Parameter Description
pInput Pointer to an IltmmFilterEnum Interface.
Name Name is a string that can show either the Display Name or the Friendly Name of the filter. It is better to use Display Name since display names are unique. Two filters can be different and yet still have the same Friendly Name. When two Friendly Names are used, this function works on the first filter it internally enumerates with the specified friendly name.
pVal Pointer to a variable to be updated with a value that indicates whether the input is enabled. Possible values are:
  Value Meaning
  VARIANT_TRUE The input is enabled.
  VARIANT_FALSE The input is disabled.

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

A DirectShow filter is enabled if its Merit is above 0x00200000. Otherwise it is disabled.

Merit values are used when building filter graphs. For more information, refer to the Microsoft documentation for DirectShow Merit.

A Display Name uniquely identifies a DirectShow filter (or any filter). Display names for software filters have the following format:

 @device:sw:GUID\\GUID

For example, Microsofts MPEG-2 Splitter display name is:

@device:sw:{083863F1-70DE-11D0-BD40-00A0C911CE86}\\{3AE86B20-7BE8-11D1-ABE6-00A0C905F375}.

Since a Friendly Name is not unique there can be more than one filter with the same name. Despite this, it is useful as a descriptive name in user interfaces. For example, the Friendly Name for Microsofts MPEG-2 Splitter is

MPEG-2 Splitter

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:

IltmmFilterEnum::put_Enable

Topics:

Multimedia Function Groups

Example

For a C++ example, refer to IltmmFilterEnum Example for C++.

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help