20.1.20 ead_get_group_names()(最上位階層のグループ名の一覧の取得)
(1) 機能
指定したEADSサーバに格納されている最上位階層のグループ名の一覧を取得します。
グループ名の一覧は,ASCIIコードの昇順になります。
(2) 形式
#include <eads.h> ead_group_names ead_get_group_names ( const EAD_CACHE *cp, /* In */ const ead_node *target_node, /* In */ int *error_code /* Out */ );
(3) 引数
- cp
-
グループ名の一覧を取得するキャッシュのハンドル(ポインタ)を指定します。
ead_start_cache()で取得したハンドルを指定してください。
- target_node
-
取得先のEADSサーバ(ead_node構造体)を指すポインタを指定します。
EADSが提供するクライアントライブラリを使用して取得したead_node構造体のポインタだけ指定できます。それ以外のポインタを指定した場合の動作は保証しません。
ead_node構造体の形式と説明については,「20.1.54 ead_node構造体(EADSサーバ指定のユーザファンクションで使用するオブジェクト)」を参照してください。
指定したead_node構造体が格納するアドレス情報(IPアドレスおよびポート番号)が,EADSクライアントが保持するどのEADSサーバのアドレス情報とも一致しない場合,エラーとなります。
- error_code
-
エラーコード取得先のポインタを指定します。
エラーコードについては,「20.2 クライアントライブラリのエラーコード(C言語)」を参照してください。
(4) 戻り値
指定したEADSサーバに格納されている最上位階層のグループ名の一覧(ead_group_names構造体)が返却されます。
次の場合,ead_group_names構造体のgroup_namesメンバにNULLが返却されます。
-
指定したEADSサーバに,グループに属するkeyが存在しない場合
-
エラーによってグループ名の一覧の取得に失敗した場合
ead_group_names構造体の形式と説明については,「20.1.46 ead_group_names構造体(複数のグループ名)」を参照してください。
(5) 注意事項
-
戻り値として返却されたead_group_names構造体のgroup_namesメンバがNULLでない場合,メモリ領域は自動的に解放されないため,APで解放してください。詳細については,「19.1.1(10) 戻り値として返却されたメモリ領域を解放する」を参照してください。
-
指定したEADSサーバに存在するグループの数が多いほど,取得に時間が掛かったり,リソースの使用量が増加したりするおそれがあります。