20.1.21 ead_get_group_keys()(グループ指定によるkeyの一覧の取得)
(1) 機能
指定したグループに属するkeyの一覧を,下位階層のグループに属するkeyも含めて取得します。
keyの一覧は,ASCIIコードの昇順になります。
(2) 形式
#include <eads.h> ead_keys ead_get_group_keys ( const EAD_CACHE *cp, /* In */ const char *group_name, /* In */ int *error_code /* Out */ );
(3) 引数
- cp
-
keyの一覧を取得するキャッシュのハンドル(ポインタ)を指定します。
ead_start_cache()で取得したハンドルを指定してください。
- group_name
-
グループ名を指定します。
指定できるデータについては,「15.2.2(2) グループ名として指定できるデータ」を参照してください。
- error_code
-
エラーコード取得先のポインタを指定します。
エラーコードについては,「20.2 クライアントライブラリのエラーコード(C言語)」を参照してください。
(4) 戻り値
指定したグループに属するkeyの一覧(ead_keys構造体)がASCIIコードの昇順で返却されます。
次の場合,ead_keys構造体のkeysメンバにNULLが返却されます。
-
指定したグループに属するkeyが存在しない場合
-
エラーによってkeyの一覧の取得に失敗した場合
ead_keys構造体の形式と説明については,「20.1.45 ead_keys構造体(複数のkey)」を参照してください。
(5) 注意事項
-
戻り値として返却されたead_keys構造体のkeysメンバがNULLでない場合,メモリ領域は自動的に解放されないため,APで解放してください。詳細については,「19.1.1(10) 戻り値として返却されたメモリ領域を解放する」を参照してください。
-
指定したEADSサーバに存在するkeyの数が多いほど,取得に時間が掛かったり,リソースの使用量が増加したりするおそれがあります。