IEncoderAPI::IsSupported Method

2009-01-07

Note The IEncoderAPI interface is deprecated. Use ICodecAPI instead.
The IsSupported method queries whether a given parameter is supported.

Syntax

HRESULT IsSupported(
  [in]  const GUID *Api
);

Parameters

Api [in]
Pointer to a GUID that specifies the parameter.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The encoder supports the parameter.
E_NOTIMPL	The encoder does not support the parameter.

Remarks

The method returns S_OK if the encoder recognizes the GUID. To check whether the parameter can be read or modified, call the IEncoderAPI::IsAvailable method.

Any errors besides those in the table above indicate an inability to process the call.

Requirements

Header	Declared in Strmif.h; include Dshow.h.
Library	Use Strmiids.lib.

Share via