EssResetPerfStats

Description

EssResetPerfStats() resets values in the performance statistics tables to zero.

Syntax

ESS_FUNC_M EssResetPerfStats (hCtx, persistence, scope);

ESS_HCTX_ThCtx;
ESS_ULONG_Tpersistence;
ESS_ULONG_Tscope;

Parameters

hCtxEssbase API context handle
persistence One of the following values indicating the persistence of the set of tables to be reset:
0: Reset short term tables only
1: Reset short and medium term tables
2: Reset short, medium and long term tables
3: Disable performance statistics gathering
4: Enable performance statistics gathering
scope One of the following values indicating the scope of the set of tables to be reset:
1: Reset thread-based tables only
2: Reset database-based tables only
4: Reset server-based tables only
7: Reset all tables

Return Value

If successful, EssResetPerfStats returns 0.

Notes

Access

The caller of this function must have supervisor access.

Example

/* This function resets all short term tables */

ESS_STS_T ESSResetPerfStats(ESS_HCTX_T *context)
{
  ESS_STS_T   sts         = ESS_STS_NOERR;
  ESS_ULONG_T persistence = 0;
  ESS_ULONG_T scope       = 7;

  sts = EssResetPerfStats(context, persistence, scope);

  return sts;
}

See Also

EssDumpPerfStats()
EssGetStatBufSize()