In This Topic ▼

IltmmFilterEnum::put_Enable

Summary

Enables or disables a DirectShow filter.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmFilterEnum_put_Enable(pInput, Name, newVal)
C++	HRESULT put_Enable(Name, newVal)

Parameters

IltmmFilterEnumt *pInput

Pointer to an IltmmFilterEnum Interface.

BSTR 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.

VARIANT_BOOL newVal

Flag that indicates whether to enable or disable the audio input. Possible values are:

Value	Meaning
VARIANT_TRUE	Enable the input.
VARIANT_FALSE	Disable the input.

Returns

Value	Meaning
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, Microsoft 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 Microsoft MPEG-2 Splitter is

MPEG-2 Splitter