# EssListSpoolFiles

Description

EssListSpoolFiles() lists all spool files for a database.

Syntax

    ESS_FUNC_M EssListSpoolFiles (hCtx, AppName, DbName, pCount, ppFileList);

ESS_HCTX_T | hCtx
ESS_STR_T | AppName
ESS_STR_T | DbName
ESS_PUSHORT_T | pCount
ESS_PPOBJINFO_T | ppFileList

Parameters

hCtx | Essbase API context handle.
AppName | Application name.
DbName | databasename.
pCount | Address of variable to receive count of spool file names.
ppFilterList | Address of pointer to receive an allocated array of spool file name strings.

Return Value

If successful, returns the count of spool files in the database in pCount, and an array of spool file names in ppFilterList.

Notes

- The memory allocated for EssListSpoolFiles() should be freed using EssFree().

Access

This function requires the caller to have database Design privilege (ESS_PRIV_DBDESIGN) for the specified database.

Example

See Also

EssDisplayTriggers EssGetSpoolFiles EssDeleteAllSplFiles EssDeleteSplFile EssMdxTrig