IPrefetchableSupport Class Reference

Indicates that the Plug-in could or not support Prefetch (dynamically). More...

#include <ivstprefetchablesupport.h>

Inheritance diagram for IPrefetchableSupport:

Public Member Functions
virtual tresult	getPrefetchableSupport (PrefetchableSupport &prefetchable)=0
	retrieve the current prefetch support. More...
Public Member Functions inherited from FUnknown
virtual tresult	queryInterface (const TUID _iid, void **obj)=0
virtual uint32	addRef ()=0
virtual uint32	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from FUnknown
static const FUID	iid

Detailed Description

Indicates that the Plug-in could or not support Prefetch (dynamically).

• [plug imp]
• [extends IComponent]
• [released: 3.6.5]
• [optional]

The Plug-in should implement this interface if it needs to dynamically change between Prefetchable or not. By default (without implementing this interface) the host will decide in which mode the Plug-in will be process. For more info about Prefetch processing mode check ProcessModes::kPrefetch documentation.

Example

tresult PLUGIN_API myPlug::getPrefetchableSupport (PrefetchableSupport& prefetchable)
{
    prefetchable = kIsNeverPrefetchable;

    switch (myPrefetchableMode)
    {
        case 0: prefetchable = kIsNeverPrefetchable; break;
        case 1: prefetchable = kIsYetPrefetchable; break;
        case 2: prefetchable = kIsNotYetPrefetchable; break;
    }
    return kResultOk;
}

Member Function Documentation

virtual tresult getPrefetchableSupport ( PrefetchableSupport &  prefetchable )

pure virtual

retrieve the current prefetch support.

Use IComponentHandler::restartComponent (kPrefetchableSupportChanged) to inform the host that this support has changed.

Member Data Documentation

const FUID iid

static