SPCaches.h File Reference

#include "SPTypes.h"
#include "SPMData.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPPurgeCachesMessage
	Message passed with the kSPPluginPurgeCachesSelector. More...
struct	SPCachesSuite
	This suite allows you to manage PICA cache memory. More...
Defines
#define	kSPCachesSuite   "SP Caches Suite"
	Cache suite name.
#define	kSPCachesSuiteVersion   2
	Cache suite version.
#define	kSPCacheCaller   "SP Cache"
	The cache management caller.
#define	kSPPluginPurgeCachesSelector   "Plug-in Purge"
	Received by plug-in adapters with the PIAcceptsPurgeCachesMessage flag set in the PIConditionalMessages property, when a call has been made to SPCachesSuite::SPFlushCaches().
Typedefs
typedef SPErr(*	SPFlushCachesProc )(const char *type, void *data, ai::int32 *flushed)
	Prototype for the cache-flushing procedure an adapter calls in response to the kSPAdaptersDisposeInfoSelector, to determine which plug-ins to unload, and inform the caller of whether its managed plug-in have been unloaded.
Functions
SPAPI SPErr	SPFlushCaches (SPFlushCachesProc flushProc, ai::int32 *flushed)
	Internal.

---

Define Documentation

#define kSPCachesSuite   "SP Caches Suite"

Cache suite name.

#define kSPCachesSuiteVersion   2

Cache suite version.

---

Typedef Documentation

typedef SPErr(* SPFlushCachesProc)(const char *type, void *data, ai::int32 *flushed)

Prototype for the cache-flushing procedure an adapter calls in response to the kSPAdaptersDisposeInfoSelector, to determine which plug-ins to unload, and inform the caller of whether its managed plug-in have been unloaded.

Parameters:

	type	The plug-in type, as set by the adapter. For PICA plug-ins, this type is kSPFlushAccessType.
	data	A pointer to the adapter-defined plug-in data. For PICA plug-ins, this data is an SPAccessRef.
	flushed	[out] A buffer in which to return the result, the number of plug-ins actually unloaded.

---

Function Documentation

SPAPI SPErr SPFlushCaches	(	SPFlushCachesProc	flushProc,
		ai::int32 *	flushed
	)

Internal.