EssDumpPerfStats

パフォーマンス統計テーブルを文字配列としてダンプします。

構文

            ESS_FUNC_M EssDumpPerfStats (hCtx, pStatBuf, [thdSN])

パラメータ	データ型	説明
hCtx;	ESS_HCTX_T	APIコンテキスト・ハンドル(入力)。
pStatBuf;	ESS_STR_T	パフォーマンス統計テーブルのダンプ先アドレスへのポインタ(入力)。
thdSN;	ESS_INT_T	オプション。統計をダンプするスレッド・シリアル番号(入力)。デフォルトは0です(すべてのスレッドがダンプされます)。

備考

この関数を呼び出す前にEssGetStatBufSizeを呼び出して、pStatBufで指定されたアドレスにパフォーマンス統計テーブル用に割り当てるためのメモリー量を確認します。

戻り値

成功の場合、この関数は
- 0を戻します。
- パフォーマンス統計テーブルが、pStatBufで指定されたアドレスから始まる文字配列としてダンプされます。
この関数の呼出し元は、pStatBufで指定されたアドレスのメモリーの割当てと解放を行います。
パフォーマンス統計テーブルの詳細は、『Oracle Essbaseテクニカル・リファレンス』を参照してください。

アクセス

この関数を使用するには、スーパーバイザ・アクセス権が必要です。

例

         /* This function gets the array of performance stats */

ESS_STS_T ESSGetPerfStats(ESS_HCTX_T *context)
{
  ESS_STS_T    sts;
  ESS_ULONG_T  bufsize;
  ESS_PUCHAR_T poutarray;  /* Pointer to the stats staging area */

  /* Get the size of the output buffer */
  if(sts = EssGetStatBufSize(context, &bufsize))
    return(sts);

  if(bufsize)
  {
    /* Allocate a staging area */
    (ESS_PVOID_T)(poutarray) = malloc (bufsize);

    /* Fill the staging area */
    sts = EssDumpPerfStats(context, poutarray);
    if(sts)
      return(sts);

    /* Do something useful with the stats here */
    /* ....................................... */
        
    /* Free the staging area */
    sts = EssFree(context, poutarray);
    if(sts)
      return(sts);
  }
  else
  {
    printf("Performance Statistics not enabled, call ResetPerfStats()\n");
  }
  return(ESS_STS_NOERR);
}