20.1.26　ead_get_group_first_key()（グループ指定による先頭のkeyの取得）

(1)　機能

指定したグループに属するkeyのうち，ASCIIコードの昇順で先頭となるkeyを取得します。指定したグループの下位階層のグループに属するkeyも取得対象となります。

ページの先頭へ

(2)　形式

#include <eads.h>
char* ead_get_group_first_key
(
  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のうち，ASCIIコードの昇順で先頭となるkeyが返却されます。

次の場合，NULLが返却されます。

• 指定したグループに属するkeyが存在しない場合

• エラーによってkeyの数の取得に失敗した場合

ページの先頭へ

(5)　注意事項

keyの取得に成功した場合（戻り値がNULLでない場合），メモリ領域は自動的に解放されないため，APで解放してください。詳細については，「19.1.1(10)　戻り値として返却されたメモリ領域を解放する」を参照してください。

ページの先頭へ