Returns a pointer to the size of the buffer needed for the performance statistics tables retrieved by EssDumpPerfStats().
Syntax
| Parameter | Data Type | Description |
|---|---|---|
hCtx; | ESS_HCTX_T | API context handle |
pBufSize; | ESS_PULONG_T | Pointer to the size of the buffer needed for the character array that will hold the performance statistics tables |
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.
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 Oracle Essbase Technical Reference.
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