# EssGetStatBufSize

Description

EssGetStatBufSize() returns a pointer to the size of the buffer needed for the performance statistics tables retrieved by EssDumpPerfStats().

Syntax

ESS_FUNC_M EssGetStatBufSize (hCtx, pBufSize);

ESS_HCTX_T | hCtx;
ESS_PULONG_T | pBufSize;

Parameters

hCtx | Essbase API context handle
pBufSize | Pointer to the size of the buffer needed for the character array that will hold the performance statistics tables

Return Value

- If successful,
  - EssGetStatBufSize() returns 0.
  - pBufSize contains a pointer to the size of the buffer needed for the character array that will hold the performance statistics tables retrieved by EssDumpPerfStats().
- For more information on performance statistics tables, see the ESSCMD commands GETPERFSTATS and RESETPERFSTATS in the Technical Reference.

Notes

- Before you call EssDumpPerfStats(), call EssGetStatBufSize() to ascertain how much memory to allocate for the performance statistics tables at the address pointed to by pStatBuf.
- The buffer size pointed to by pBufSize is 0 if performance statistics have never been enabled; that is, if persistence in EssResetPerfStats() has never been set to 4.

Access

The caller of this function must have supervisor access.

Example

For a code example that calls EssGetStatBufSize(), see the example in EssDumpPerfStats().

See Also

EssDumpPerfStats()
EssResetPerfStats()