20.1.18 ead_remove_group()(グループ指定によるvalueの一括削除)
(1) 機能
指定したグループに属するkeyおよびvalueを,下位階層のグループに属するkeyおよびvalueも含めて一括削除します。
keyおよびvalueの一括削除中に何らかの要因で削除に失敗した場合は,失敗の要因を示すエラーコードが返却されます。
(2) 形式
#include <eads.h> void ead_remove_group ( const EAD_CACHE *cp, /* In */ const char *group_name, /* In */ int *error_code /* Out */ );
(3) 引数
- cp
-
削除するvalueが格納されているキャッシュのハンドル(ポインタ)を指定します。
ead_start_cache()で取得したハンドルを指定してください。
- group_name
-
削除するkeyおよびvalueが属するグループ名を指定します。
指定できるデータについては,「15.2.2(2) グループ名として指定できるデータ」を参照してください。
- error_code
-
エラーコード取得先のポインタを指定します。
エラーコードについては,「20.2 クライアントライブラリのエラーコード(C言語)」を参照してください。
(4) 注意事項
-
削除に失敗した場合,削除対象のデータが残っているおそれがあります。そのため,実行結果を確認して対処してください。必要に応じて,ead_remove_group()(グループ指定によるvalueの一括削除)を再度実行してください。
-
キャッシュの操作が部分的に失敗した場合,戻り値からどの操作が失敗したか判別して,必要に応じて再実行してください。
-
キャッシュの操作中に排他処理はされません。そのため,一括操作中に,ほかのキャッシュ操作によって操作対象のvalueが変更されることがあります。
-
大量のデータを一括操作する場合,EADSクライアントおよびEADSサーバでメモリが大量に消費されることがあります。
-
大量のデータを一括操作する場合,操作の完了までに時間が掛かることがあります。そのため,タイムアウト時間を適切に設計してください。