dc_dam_read

ANSI C ，C++の形式

#include <dcdam.h>
int  dc_dam_read(int damfd,struct DC_DAMKEY *keyptr,int keyno,
                 char *bufadr,int bufsize,DCLONG flags)

K&R版 C の形式

#include <dcdam.h>
int dc_dam_read(damfd,keyptr,keyno,bufadr,bufsize,flags)
int            damfd;
struct DC_DAMKEY *keyptr;
int            keyno;
char           *bufadr;
int            bufsize;
DCLONG         flags;

●damfd

ブロックを入力するファイルの，ファイル記述子を設定します。

●keyptr

参照または更新するブロックの範囲を示す構造体（DAMキー）のアドレスを設定します。構造体にはブロックの範囲を，先頭の相対ブロック番号と最後の相対ブロック番号で設定します。構造体の形式は次のとおりです。

struct DC_DAMKEY {
                  int fstblkno;
                  int endblkno;
                  };

• fstblkno

  参照または更新するブロックの，先頭の相対ブロック番号を設定します。

• endblkno

  参照または更新するブロックの，最後の相対ブロック番号を設定します。0を設定した場合は，fstblknoで設定した相対ブロック番号のブロックだけを入力します。

●keyno

keyptrで設定する構造体の数（構造体の配列数）を設定します。

●bufadr

入力バッファのアドレスを設定します。

●bufsize

入力バッファ長を（入力ブロック長 × ブロック数）以上の値で設定します。設定できる範囲は504〜2147483647です。

●flags

参照要求か更新要求かの種別を設定します。次の形式で設定します。

{DCDAM_REFERENCE｜DCDAM_MODIFY}
〔｜{DCDAM_EXCLUSIVE｜DCDAM_NOEXCLUSIVE}〕
〔｜{DCDAM_WAIT｜DCDAM_NOWAIT}〕

• フラグ1

  dc_dam_read関数で入力する種別（参照目的か更新目的か）を設定します。

  DCDAM_REFERENCE…参照目的の入力。

  DCDAM_MODIFY……更新目的の入力。

• フラグ2

  参照目的の入力の場合，排他をかけるかどうかを指定します。DCDAM_EXCLUSIVEを設定した場合は，同期点の処理まで排他をかけます。

  トランザクションの外から回復対象のDAMファイルに参照目的でアクセスする場合は，排他する指定はできません。

  フラグ2を省略した場合は，DCDAM_NOEXCLUSIVEが仮定されます。

  排他をかけないでdc_dam_read関数を呼び出した場合，dc_dam_read関数の処理中にほかのUAPから該当するブロックが更新されることがあります。この場合，dc_dam_read関数で入力するブロックの内容は，ほかのUAPでの更新処理の状態に依存します。したがって，最新のブロックの内容を参照する場合には，必ずDCDAM_EXCLUSIVEを指定してください。

  更新目的の入力の場合，フラグ2に値を設定できません（強制的にDCDAM_EXCLUSIVEとなります）。

  DCDAM_EXCLUSIVE…排他をします。

  DCDAM_NOEXCLUSIVE…排他をしません。

• フラグ3

  排他エラーが起こったとき，排他解除待ちをするかどうかを設定します。この値はDCDAM_NOEXCLUSIVEと同時には設定できません。

  damfdに設定したファイル記述子のdc_dam_open関数が，排他種別にファイル排他を設定していた場合は，ここに設定する値は意味を持ちません。

  DCDAM_WAIT…排他解除待ちをします。

  DCDAM_NOWAIT…待たないで，エラーリターンします。

どちらも設定しなかった場合は次のようになります。

• dc_dam_open関数でDCDAM_WAITを設定していれば，排他解除待ち

• dc_dam_open関数でDCDAM_NOWAITを設定，または省略している場合はエラーリターン

flagsの値に設定したフラグと，排他の設定内容の対応を次に示します。

フラグ1	フラグ2※1	フラグ3※2	flagsの設定内容
REFERENCE	EXCLUSIVE	WAIT	参照目的，排他あり，排他エラー時は解除待ち
		NOWAIT	参照目的，排他あり，排他エラー時はエラーリターン
	NOEXCLUSIVE	×	参照目的，排他なし※3
MODIFY	×	WAIT	更新目的，排他エラー時は解除待ち
		NOWAIT	更新目的，排他エラー時はエラーリターン