SPCachesSuite Struct Reference
[API Suite List]

This suite allows you to manage PICA cache memory. More...

#include <SPCaches.h>

List of all members.

Public Attributes
SPAPI SPErr(*	SPFlushCaches )(SPFlushCachesProc flushProc, ai::int32 *flushed)
	Sends a message to all plug-in adapters telling them to unload any unused plug-ins from memory.

---

Detailed Description

This suite allows you to manage PICA cache memory.

PICA plug-ins are intended to move in and out of memory (cache) as necessary, to allow a small memory footprint. By default, PICA keeps loaded plug-ins in cache until the application heap has been filled, and then unloads them. Beyond this simple strategy, the application and plug-ins can use this function to unload plug-ins when needed. Plug-ins do not typically need to do this.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kSPCachesSuite and kSPCachesSuiteVersion.

---

Member Data Documentation

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

Sends a message to all plug-in adapters telling them to unload any unused plug-ins from memory.

Parameters:

	flushProc	The procedure the adapter uses to determine which plug-ins to unload.
	flushed	[out] A buffer in which to return the result of the procedure calls, the total number of plug-ins actually unloaded.

---

The documentation for this struct was generated from the following file:

• SPCaches.h