Microsoft DirectX 8.1 (C++)

IAMTimelineEffectable::GetEffect

The GetEffect method retrieves the effect at the specified priority level.

Syntax

HRESULT GetEffect(
    IAMTimelineObj **ppFx,
    long Which
);

Parameters

ppFX

[out] Address of a pointer that receives the effect's IAMTimelineObj interface.

Which

Priority level of the effect to retrieve.

Return Value

Returns an HRESULT value. Possible values include the following:

Return code Description
S_FALSE No effect at the specified priority,
S_OK Success.
E_POINTER NULL pointer argument.

Remarks

If the method returns S_OK, the IAMTimelineObj interface that it returns has an outstanding reference count. Be sure to release the interface when you are finished using it.

See Also