Edit

IMILBitmapEffectPrimitiveImpl::IsVolatile method (mileffects.h)

  • Article

Determines whether the current effect is considered volatile. If an effect is volatile, the effects framework will not attempt to cache the effect's output.

Syntax

HRESULT IsVolatile(
  [in]          ULONG        uiOutputIndex,
  [out, retval] VARIANT_BOOL *pfVolatile
);

Parameters

[in] uiOutputIndex

Type: ULONG

A zero based index value indicating the output pin to query.

[out, retval] pfVolatile

Type: VARIANT_BOOL*

When this method returns, contains a value indicating whether the effect is considered volatile.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mileffects.h
Redistributable Microsoft .Net 3.0