ある特定のEssbaseサーバー、アプリケーションまたはデータベースへのアクセス権を持つすべてのグループをリストします。
構文
ESS_FUNC_M EssListGroups (
hCtx, AppName, DbName, pCount, ppGroupList
);
| パラメータ | データ型 | 説明 |
|---|---|---|
hCtx |
ESS_HCTX_T |
APIコンテキスト・ハンドル。 |
AppName |
ESS_STR_T |
アプリケーション名。NULLの場合は全グループがリストされます。 |
DbName |
ESS_STR_T |
データベース名。NULLの場合はアプリケーション内のすべてのデータベースのグループがリストされます。 |
pCount |
ESS_PUSHORT_T |
グループのカウントを受け取る変数のアドレス。 |
ppGroupList |
ESS_USERINFO_T, ESS_GROUPINFO_T |
割り当てられたグループ情報構造体の配列を受け取るポインタのアドレス。 |
備考
AppNameとDbNameの両方がNULLでない場合、指定されたアプリケーションとデータベースへのアクセス権があるグループのみがリストされます。DbNameがNULLの場合、指定したアプリケーションへのアクセス権を持つグループのみがリストされます。AppNameがNULLの場合、ログオンしているサーバー上のすべてのグループがリストされます。
ppGroupListに対して割り当てられたメモリーは、EssFreeを使用して解放する必要があります。
戻り値
正常終了の場合、グループ数のカウントがpCountに、指定されたアプリケーションおよびデータベースへのアクセス権を持つグループのリストがppGroupListに戻されます。
アクセス
この関数を使用するのに、特別な権限は必要ありません。
例
ESS_FUNC_M
ESS_ListGroups (ESS_HCTX_T hCtx,
ESS_HINST_T hInst
)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_USHORT_T Count;
ESS_PGROUPINFO_T Groups = NULL;
ESS_USHORT_T ind;
sts = EssListGroups (hCtx, NULL, NULL, &Count, &Groups);
if (!sts)
{
if (Count && Groups)
{
printf ("\r\n-----Group List-----\r\n\r\n");
for (ind = 0; ind < Count; ind++)
printf ("Name->%s\r\n", Groups [ind].Name);
EssFree (hInst, Groups);
}
else
printf ("\r\nGroup List is Empty\r\n\r\n");
}
return (sts);
}
関連トピック