kv_lob_get_for_read()

#include <kvstore.h>

kv_error_t 
kv_lob_get_for_read(kv_store_t *store,
                    const kv_key_t *key,
                    kv_lob_handle_t **handle,
                    kv_consistency_t *consistency,
                    kv_timeout_t timeout_ms); 

ストアからラージ・オブジェクトを読み取るためのLOBハンドルを割り当てて構成します。ハンドルが正常に作成されると、KV_SUCCESSが返されます。それ以外の場合は、KV_NO_MEMORYが返されます。

このハンドルをオープンするとき、kv_lob_read()を使用して実際の読取り操作を実行します。

この関数によって割り当てられたLOBハンドルは、kv_lob_release_handle()を使用して解放する必要があります。

パラメータ

• store

  storeパラメータは、LOBレコードの読取り元であるストアへのハンドルです。

• key

  keyパラメータは、LOBレコードのキーです。ここで使用する最終パス・コンポーネントは、ストアに対して構成したLOB接尾辞を指定する必要があり、指定しない場合、読取り操作は失敗します。LOB接尾辞は、kv_config_set_lob_suffix()を使用してストア用に構成します。

• handle

  handleパラメータは、割り当てられたLOBハンドル(構造)へのポインタのコピー先であるメモリーを参照します。

• consistency

  consistencyパラメータは、この読取り操作で使用する一貫性ポリシーです。一貫性ポリシーは、kv_create_simple_consistency()、kv_create_time_consistency()またはkv_create_version_consistency()を使用して作成します。

  NULLの場合、ストアのデフォルトの一貫性ポリシーが使用されます。

• timeout_ms

  timeout_msパラメータは、GET操作を処理する際の時間間隔の上限をミリ秒単位で識別します。指定された限度を超えないよう最善が尽くされます。ゼロの場合は、デフォルトの要求タイムアウトが使用されます。

関連項目

• データ操作および関連関数