Hitachi

インメモリデータグリッド Hitachi Elastic Application Data Store ユーザーズガイド


20.1.27 ead_get_node_first_key()(EADSサーバ指定による先頭のkeyの取得)

〈この項の構成〉

(1) 機能

指定したEADSサーバに格納されているkeyのうち,ASCIIコードの昇順で先頭となるkeyを取得します。

(2) 形式

#include <eads.h>
char* ead_get_node_first_key
(
  const EAD_CACHE     *cp,             /* In */
  const ead_node      *target_node,    /* In */ 
  int                 *error_code      /* Out */
);

(3) 引数

cp

keyを取得するキャッシュのハンドル(ポインタ)を指定します。

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サーバに格納されているkeyのうち,ASCIIコードの昇順で先頭となるkeyが返却されます。

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

(5) 注意事項

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