20.1.15 ead_get_group()(グループ指定によるvalueの一括取得)
(1) 機能
指定したグループおよびその下位階層のグループに属するkeyに関連づけられたvalueを一括取得します。
(2) 形式
#include <eads.h> ead_get_group_results ead_get_group ( const EAD_CACHE *cp, /* In */ const char *group_name, /* In */ int *error_code /* Out */ );
(3) 引数
- cp
-
取得するvalueが格納されているキャッシュのハンドル(ポインタ)を指定します。
ead_start_cache()で取得したハンドルを指定してください。
- group_name
-
valueを取得するグループ名を指定します。
指定できるデータについては,「15.2.2(2) グループ名として指定できるデータ」を参照してください。
- error_code
-
エラーコード取得先のポインタを指定します。
エラーコードについては,「20.2 クライアントライブラリのエラーコード(C言語)」を参照してください。
(4) 戻り値
指定したグループおよびその下位階層のグループに属するkeyに関連づけられたvalueの一括取得の結果(ead_get_group_results構造体)が返却されます。
-
一括取得に一部またはすべて成功した場合
valueの取得が成功した分のkey,および引数に指定したkeyの一覧に対応するvalueが,key_value_arrayメンバに返却されます。
-
一括取得にすべて失敗した場合
ead_get_group_results構造体の数値型のメンバは0,ポインタ型のメンバはNULLになります。
ead_get_group_results構造体の形式と説明については,「20.1.49 ead_get_group_results構造体(ead_get_group()の実行結果)」を参照してください。
(5) 注意事項
-
戻り値として返却された,valueの一括取得の結果を格納するメモリ領域は,自動的に解放されないため,APで解放してください。詳細については,「19.1.1(10) 戻り値として返却されたメモリ領域を解放する」を参照してください。
-
キャッシュの操作が部分的に失敗した場合,キャッシュの操作の実行結果を確認して,必要に応じて再実行してください。
-
キャッシュの操作中に排他処理はされません。そのため,一括操作中に,ほかのキャッシュ操作によって操作対象のvalueが変更されることがあります。
-
大量のデータを一括操作する場合,EADSクライアントおよびEADSサーバでメモリが大量に消費されることがあります。
-
大量のデータを一括操作する場合,操作の完了までに時間が掛かることがあります。そのため,タイムアウト時間を適切に設計してください。