SPRuntimeSuite Struct Reference
[API Suite List]

This suite allows you to obtain specific references to the PICA global lists and string pool. More...

#include <SPRuntme.h>

Public Attributes
SPAPI SPErr(*	GetRuntimeStringPool )(SPStringPoolRef *stringPool)
	Retrieves the PICA global string pool.
SPAPI SPErr(*	GetRuntimeSuiteList )(SPSuiteListRef *suiteList)
	Retrieves the PICA global suite list.
SPAPI SPErr(*	GetRuntimeFileList )(SPFileListRef *fileList)
	Retrieves the PICA global file list.
SPAPI SPErr(*	GetRuntimePluginList )(SPPluginListRef *pluginList)
	Retrieves the PICA global plug-in list.
SPAPI SPErr(*	GetRuntimeAdapterList )(SPAdapterListRef *adapterList)
	Retrieves the PICA global adapter list.
SPAPI SPErr(*	GetRuntimeHostProcs )(SPHostProcs **hostProcs)
	Retrieves the block of function pointers supplied to PICA by the application, which contains memory management routines, notification routines, exception handling, and string pool routines.
SPAPI SPErr(*	GetRuntimePluginsFolder )(SPPlatformFileReference *pluginFolder)
	Retrieves the location of the application's plug-in folder.
SPAPI SPErr(*	GetRuntimeHostFileRef )(SPPlatformFileReference *hostFileSpec)
	Retrieves the location of the application's executable file.

Detailed Description

This suite allows you to obtain specific references to the PICA global lists and string pool.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kSPRuntimeSuite and kSPRuntimeSuiteVersion.

Member Data Documentation

SPAPI SPErr(* SPRuntimeSuite::GetRuntimeAdapterList)(SPAdapterListRef *adapterList)

Retrieves the PICA global adapter list.

Parameters:

adapterList

[out] A buffer in which to return the list object.

See also:: SPAdaptersSuite

SPAPI SPErr(* SPRuntimeSuite::GetRuntimeFileList)(SPFileListRef *fileList)

Retrieves the PICA global file list.

Parameters:

fileList

[out] A buffer in which to return the list object.

See also:: SPFilesSuite

SPAPI SPErr(* SPRuntimeSuite::GetRuntimeHostFileRef)(SPPlatformFileReference *hostFileSpec)

Retrieves the location of the application's executable file.

Parameters:

hostFileSpec

[out] A buffer in which to return the file specification for the application's executable file.

SPAPI SPErr(* SPRuntimeSuite::GetRuntimeHostProcs)(SPHostProcs **hostProcs)

Retrieves the block of function pointers supplied to PICA by the application, which contains memory management routines, notification routines, exception handling, and string pool routines.

A plug-in does not normally call the host functions directly; you can use the PICA suite functions for most operations. An adapter, however, uses the host functions for start-up and shut-down notification.

Parameters:

hostProcs

[out] A buffer in which to return a pointer to the block of function pointers.

SPAPI SPErr(* SPRuntimeSuite::GetRuntimePluginList)(SPPluginListRef *pluginList)

Retrieves the PICA global plug-in list.

Parameters:

pluginList

[out] A buffer in which to return the list object.