COBOL ファイルアクセスルーチン使用手引書

Transcription

1 Microsoft Windows Server 2003 Microsoft Windows Server 2008 B1WD133101Z0(00) NetCOBOL V10.0 COBOL ファイルアクセスルーチン 使 用 手 引 書

2

3 まえがき COBOLファイルアクセスルーチンは COBOLファイルを 操 作 するためのC 言 語 用 のAPI(Application Program Interface) 関 数 群 です この 関 数 群 を 利 用 することによって COBOLファイルをアクセスする64ビットアプリケーション の 開 発 / 運 用 を 行 うことができます 製 品 の 呼 び 名 について 本 書 では 各 製 品 を 次 のように 略 記 しています あらかじめご 了 承 ください 正 式 名 称 略 称 Microsoft(R) Windows(R) 2000 Professional operating system Windows 2000 Microsoft(R) Windows(R) 2000 Server operating system Microsoft(R) Windows(R) 2000 Advanced Server operating system Microsoft(R) Windows(R) XP Home Edition operating system Microsoft(R) Windows(R) XP Professional operating system Microsoft(R) Windows Server(R) 2003, Standard Edition Microsoft(R) Windows Server(R) 2003 R2, Standard Edition Microsoft(R) Windows Server(R) 2003, Standard x64 Edition Microsoft(R) Windows Server(R) 2003, Enterprise Edition Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition Microsoft(R) Windows Server(R) 2003, Enterprise x64 Edition Microsoft(R) Windows Server(R) 2003, Enterprise Edition for Itaniumbased Systems Microsoft(R) Windows Server(R) 2003, Datacenter Edition for Itaniumbased Systems Microsoft(R) Windows Vista(R) Home Basic Microsoft(R) Windows Vista(R) Home Premium Microsoft(R) Windows Vista(R) Business Microsoft(R) Windows Vista(R) Enterprise Microsoft(R) Windows Vista(R) Ultimate Microsoft(R) Windows Server(R) 2008 Standard Microsoft(R) Windows Server(R) 2008 Standard without HyperV Microsoft(R) Windows Server(R) 2008 Enterprise Microsoft(R) Windows Server(R) 2008 Enterprise without HyperV Microsoft(R) Windows Server(R) 2008 for ItaniumBased Systems Microsoft(R) Visual C++(R) development system Windows XP Windows Server 2003 Windows Server 2003(Itanium) Windows Vista Windows Server 2008 Windows Server 2008(Itanium) Visual C++ Windows Server 2003(Itanium) および Windows Server 2008(Itanium) をすべて 指 す 場 合 は Windows と 表 記 します i

4 本 書 の 目 的 本 書 はCOBOLのファイル 入 出 力 機 能 の 知 識 と C 言 語 を 用 いたプログラミングについての 知 識 があ る 方 を 対 象 としています 本 書 ではCOBOLファイルアクセスルーチンを 利 用 したCソースプログラムの 作 成 と プログラムの リンク 実 行 方 法 について 説 明 しています COBOLのファイル 入 出 力 機 能 については 以 下 のマ ニュアルを 参 照 してください COBOL 文 法 書 NetCOBOL 使 用 手 引 書 登 録 商 標 について 本 書 に 記 載 している 登 録 商 標 を 以 下 に 示 します Microsoft Windows Windows Server Windows Vista Visual C++は 米 国 Microsoft Corporation の 米 国 およびその 他 の 国 における 登 録 商 標 または 商 標 です 2008 年 6 月 Copyright FUJITSU LIMITED ii

5 目 次 第 1 章 COBOLファイルアクセスルーチンを 利 用 する 前 に COBOLファイルアクセスルーチンとは 準 備 するもの 環 境 設 定... 4 第 2 章 使 い 方 Cソースプログラムの 作 成 Cソースプログラムの 翻 訳 オブジェクトファイルのリンク プログラムの 実 行... 9 第 3 章 API 関 数 と 構 造 体 ファイルのオープン cobfa_open() ファイルのクローズ cobfa_close() レコードの 読 込 み cobfa_rdkey() cobfa_rdnext() cobfa_rdrec() レコードの 書 出 し cobfa_wrkey() cobfa_wrnext() cobfa_wrrec() レコードの 削 除 cobfa_delcurr() cobfa_delkey() cobfa_delrec() レコードの 書 換 え cobfa_rewcurr() cobfa_rewkey() cobfa_rewrec() レコードの 位 置 決 め cobfa_stkey() cobfa_strec() レコードロックの 解 除 cobfa_release() ファイル 情 報 の 取 得 cobfa_indexinfo() エラー 番 号 の 取 得 cobfa_errno() 入 出 力 状 態 の 取 得 cobfa_stat() 読 込 みレコード 長 の 取 得 cobfa_reclen() 相 対 レコード 番 号 の 取 得 cobfa_recnum() マルチスレッド 環 境 下 での 排 他 制 御 LOCK_cobfa() UNLOCK_cobfa() 使 用 する 構 造 体 struct fa_keydesc iii

6 struct fa_keylist struct fa_dictinfo ダミーファイル 第 4 章 エラー 番 号 と 入 出 力 状 態 エラー 番 号 入 出 力 状 態 第 5 章 サンプルプログラム 行 順 ファイルの 読 込 み 行 順 ファイルの 読 込 みと 索 引 ファイルの 書 出 し 索 引 ファイルの 情 報 の 取 得 第 6 章 注 意 事 項 制 限 事 項 留 意 事 項 付 録 A リファレンス A.1 API 関 数 A.2 API 関 数 で 使 用 する 構 造 体 索 引 iv

7 第 1 章 COBOLファイルアクセスルーチンを 利 用 す る 前 に ここでは COBOLファイルアクセスルーチンの 紹 介 と 準 備 するもの 環 境 設 定 について 説 明 し ます 1.1 COBOLファイルアクセスルーチンとは 1.2 準 備 するもの 1.3 環 境 設 定

8 第 1 章 COBOLファイルアクセスルーチンを 利 用 する 前 に 1.1 COBOLファイルアクセスルーチンとは COBOLファイルアクセスルーチンは COBOLファイルを 操 作 するためのC 言 語 用 のAPI(Application Program Interface) 関 数 群 です これらの 関 数 は COBOLランタイムシステムを 呼 び 出 すことに よって ファイルの 操 作 を 行 います COBOLファイルアクセスルーチンを 使 用 することにより 以 下 の 操 作 が 実 現 できます COBOLアプリケーションで 作 成 したファイルの 読 込 み/ 書 換 えなどの 既 存 資 産 への 入 出 力 COBOLで 扱 う 以 下 の 編 成 のファイルの 創 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル 索 引 ファイル COBOLアプリケーションとのファイル/レコードの 排 他 / 共 用 既 存 の 索 引 ファイルのファイル 属 性 /レコードキー 構 成 の 解 析 2

9 1.2 準 備 するもの 1.2 準 備 するもの 開 発 言 語 として64ビット(IA64) 対 応 Cコンパイラを 用 意 します Cコンパイラのインストールと その 動 作 環 境 の 設 定 を 行 っておいてください 3

10 第 1 章 COBOLファイルアクセスルーチンを 利 用 する 前 に 1.3 環 境 設 定 NetCOBOLをインストールすると COBOLファイルアクセスルーチンはNetCOBOLと 同 じフォルダに 格 納 されます NetCOBOLをインストールした 後 環 境 変 数 PATHと 環 境 変 数 LIBにNetCOBOLのインストールフォル ダが 設 定 されていることを 確 認 してください 設 定 されていなければ これらの 環 境 変 数 に NetCOBOLのインストールフォルダを 追 加 してください 環 境 変 数 の 設 定 については NetCOBOL 使 用 手 引 書 の 環 境 変 数 の 設 定 を 参 照 してください 4

11 第 2 章 使 い 方 ここでは Cソースプログラムの 作 成 翻 訳 オブジェクトファイルのリンク プログラムの 実 行 について 説 明 します 2.1 Cソースプログラムの 作 成 2.2 Cソースプログラムの 翻 訳 2.3 オブジェクトファイルのリンク 2.4 プログラムの 実 行

12 第 2 章 使 い 方 2.1 Cソースプログラムの 作 成 COBOLファイルアクセスルーチンを 用 いたCソースプログラムをテキストエディタなどで 作 成 し ます 当 アクセスルーチンを 使 う 上 での 注 意 事 項 については 第 6 章 注 意 事 項 を 参 照 してく ださい Cソースプログラムには 以 下 の 記 述 を 入 れ ヘッダファイルをインクルードすることを 明 示 しま す #include "f6agfcfa.h" 6

13 2.2 Cソースプログラムの 翻 訳 2.2 Cソースプログラムの 翻 訳 Cソースプログラムを 翻 訳 します Cコンパイラに インクルードファイルを 検 索 するパスを 指 定 する 翻 訳 オプションを 指 定 してく ださい この 翻 訳 オプションに NetCOBOLをインストールしたフォルダを 指 定 します 以 下 に Visual C++での 翻 訳 オプションを 示 します /I directory directoryには NetCOBOLをインストールしたフォルダを 指 定 します [ 例 ] /I C:\COBOL 7

14 第 2 章 使 い 方 2.3 オブジェクトファイルのリンク オブジェクトファイルをリンクし 実 行 可 能 プログラムを 作 成 します オブジェクトファイルをリンクするときは NetCOBOLをインストールしたフォルダの 中 にある 以 下 のファイルを 結 合 します F6AGFCFA.lib 8

15 2.4 プログラムの 実 行 2.4 プログラムの 実 行 作 成 したアプリケーションプログラムを 実 行 します このとき 特 に 考 慮 すべきことはありません プログラムは COBOLアプリケーションとファイ ル/レコードを 排 他 / 共 用 できます 9

16 第 2 章 使 い 方 10

17 第 3 章 API 関 数 と 構 造 体 ここでは 以 下 について 説 明 します 3.1 ファイルのオープン 3.2 ファイルのクローズ 3.3 レコードの 読 込 み 3.4 レコードの 書 出 し 3.5 レコードの 削 除 3.6 レコードの 書 換 え 3.7 レコードの 位 置 決 め 3.8 レコードロックの 解 除 3.9 ファイル 情 報 の 取 得 3.10 エラー 番 号 の 取 得 3.11 入 出 力 状 態 の 取 得 3.12 読 込 みレコード 長 の 取 得 3.13 相 対 レコード 番 号 の 取 得 3.14 マルチスレッド 環 境 下 での 排 他 制 御 3.15 使 用 する 構 造 体 3.16 ダミーファイル

18 第 3 章 API 関 数 と 構 造 体 3.1 ファイルのオープン ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルをオープンするAPI 関 数 について 説 明 します cobfa_open() cobfa_open() ファイルをオープンします long cobfa_open ( const char *fname, /* ファイル 名 */ long openflgs, /* オープン 属 性 */ const struct fa_keylist *keylist, /* レコードキーリスト */ long reclen /* レコード 長 */ ); 説 明 ファイル 名 fnameが 指 すファイルを オープン 属 性 openflgs レコード 長 reclen レコードキー リストkeylistの 情 報 をもとにオープンします COBOLアプリケーションのダミーファイルと 同 等 の 機 能 を 実 現 させたい 場 合 ファイル 名 の 末 尾 に,DUMMY を 付 加 するか またはファイル 名 として,DUMMY を 指 定 します 詳 細 は 3.16 ダ ミーファイル を 参 照 してください オープン 属 性 openflgsの 指 定 値 には 以 下 のa.からi.までの9つのカテゴリがあり これらをビッ トの 論 理 和 で 結 合 して 指 定 します カテゴリb.からi.までは 省 略 可 能 です (*は 省 略 値 ) a. オープンモード 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_INPUT INPUTモード OPEN INPUT FA_OUTPUT OUTPUTモード OPEN OUTPUT FA_INOUT IOモード OPEN IO FA_EXTEND EXTENDモード OPEN EXTEND ファイル 編 成 が 行 順 ファイル(FA_LSEQFILE)の 場 合 オープンモードにIOモード (FA_INOUT)を 指 定 することはできません 指 定 した 場 合 はエラーになります b. ファイル 編 成 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_SEQFILE レコード 順 ファイル ORGANIZATION IS SEQUENTIAL FA_LSEQFILE 行 順 ファイル ORGANIZATION IS LINE SEQUENTIAL FA_RELFILE 相 対 ファイル ORGANIZATION IS RELATIVE FA_IDXFILE 索 引 ファイル ORGANIZATION IS INDEXED 12

19 3.1 ファイルのオープン c. レコード 形 式 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_FIXLEN 固 定 長 形 式 RECORD CONTAINS integer CHARACTERS FA_VARLEN 可 変 長 形 式 RECORD IS VARYING IN SIZE d. 呼 出 し 法 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_SEQACC 順 呼 出 し ACCESS MODE IS SEQUENTIAL FA_RNDACC 乱 呼 出 し ACCESS MODE IS RANDOM FA_DYNACC 動 的 呼 出 し ACCESS MODE IS DYNAMIC ファイル 編 成 が 以 下 のどちらかの 場 合 呼 出 し 法 に 順 呼 出 し(FA_SEQACC) 以 外 を 指 定 することはできません 指 定 した 場 合 はエラーになります 行 順 ファイル(FA_LSEQFILE) または レコード 順 ファイル(FA_SEQFILE) e. ロックモード 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_AUTOLOCK 自 動 ロック LOCK MODE IS AUTOMATIC FA_MANULOCK 手 動 ロック LOCK MODE IS MANUAL FA_EXCLLOCK 排 他 ロック LOCK MODE IS EXCLUSIVE または OPEN WITH LOCK オープンモードがOUTPUTモード(FA_OUTPUT)の 場 合 ロックモードに 排 他 ロック (FA_EXCLLOCK)を 指 定 したものとして 扱 います オープンモードがINPUTモード(FA_INPUT)の 場 合 ロックモードに 自 動 ロック (FA_AUTOLOCK)または 手 動 ロック(FA_MANULOCK)を 指 定 することはできません 指 定 した 場 合 は 無 効 になります オープンモードがINPUTモード(FA_INPUT)の 場 合 ロックモードのデフォルト 値 と して 共 用 モードでファイルをオープンします 読 込 み 時 は レコードロックの 指 定 が 無 効 になります オープンモードがINPUTモード(FA_INPUT) 以 外 の 場 合 ロックモードのデフォルト 値 は 排 他 ロック(FA_EXCLLOCK)になります ファイル 編 成 が 以 下 のどちらかの 場 合 ロックモードに 手 動 ロック(FA_MANULOCK) を 指 定 することはできません 指 定 した 場 合 はエラーになります 行 順 ファイル(FA_LSEQFILE) または レコード 順 ファイル(FA_SEQFILE) f. 不 定 ファイル 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_NOTOPT 不 定 ファイルでない SELECT filename FA_OPTIONAL 不 定 ファイル SELECT OPTIONAL filename 13

20 第 3 章 API 関 数 と 構 造 体 g. 動 作 コード 系 記 号 定 数 意 味 * FA_ASCII ファイルはSJISまたはJIS8でエンコードした 文 字 データを 持 つ FA_UCS2 ファイルはUCS2でエンコードした 文 字 データを 持 つ ( 注 ) FA_UTF8 ファイルはUTF8でエンコードした 文 字 データを 持 つ FA_UCS2BE ファイルはUCS2(ビッグエンディアン)でエンコードした 文 字 データを 持 つ FA_UCS2LE ファイルはUCS2(リトルエンディアン)でエンコードした 文 字 データを 持 つ 注 :エンディアンはシステムに 依 存 し リトルエンディアンとなります 動 作 コード 系 は 行 順 ファイルが 持 つ 文 字 データのエンコード 種 別 を 指 定 するもの です 行 順 ファイルは ファイルの 構 造 がエンコード 種 別 により 異 なるため この 指 定 が 必 要 になります 動 作 コード 系 は ファイル 編 成 が 行 順 ファイル(FA_LSEQFILE)のときだけ 指 定 する ことができます その 他 のファイル 編 成 は ファイルの 構 造 がエンコード 種 別 に 依 存 しないため 動 作 コード 系 を 指 定 する 必 要 はありません 動 作 モードがUnicodeのCOBOLアプリケーションで 扱 う 行 順 ファイルで レコードの データ 項 目 が 日 本 語 項 目 の 場 合 にはFA_UCS2 FA_UCS2BE またはFA_UCS2LEを レ コードのデータ 項 目 が 日 本 語 項 目 以 外 の 場 合 にはFA_UTF8を 指 定 します 動 作 モードがUnicodeでないCOBOLアプリケーションで 扱 う 行 順 ファイルには FA_ASCIIを 指 定 します h. キーパートフラグ 使 用 指 定 記 号 定 数 FA_USEKPFLAGS 意 味 struct fa_keypart 型 の 構 造 体 のkp_flagsメンバの 指 定 値 を 有 効 とする キーパートフラグ 使 用 指 定 は レコードキーリストkeylistが 包 含 するstruct fa_keypart 型 の 構 造 体 のメンバkp_flagsの 指 定 値 を 有 効 とするときに 設 定 します struct fa_keypart 型 については struct fa_keydesc を 参 照 してくだ さい キーパートフラグ 使 用 指 定 は ファイル 編 成 が 索 引 ファイル(FA_IDXFILE)のときだ け 指 定 することができます 当 指 定 は 動 作 モードがUnicodeのCOBOLアプリケーションで 扱 う 索 引 ファイルを 使 用 する 場 合 に 必 要 です 当 指 定 の 省 略 時 は メンバkp_flagsの 指 定 値 を 無 視 します 14

21 3.1 ファイルのオープン i. BSAM 指 定 ( 高 速 処 理 およびファイルの 最 大 サイズ 拡 張 ) 記 号 定 数 FA_BSAM 意 味 BSAM(ファイルの 高 速 処 理 ) 指 定 で 操 作 する COBOLアプリケーションによる ファイルの 高 速 処 理 で 作 成 されたCOBOLファイル を 参 照 する 場 合 や COBOLアプリケーションによる ファイルの 高 速 処 理 で 参 照 されるファイルを 作 成 する 場 合 に 指 定 します フ ァ イ ル 編 成 が レ コ ー ド 順 フ ァ イ ル (FA_SEQFILE) ま た は 行 順 フ ァ イ ル (FA_LSEQFILE)の 場 合 にのみ 利 用 できます FA_BSAMを 指 定 することにより ファイルの 高 速 処 理 と 同 じファイル 最 大 サイズ の 拡 張 制 限 注 意 事 項 が 発 生 します 詳 しくは NetCOBOL 使 用 手 引 書 の ファイルの 高 速 処 理 を 参 照 してください レコード 形 式 が 固 定 長 形 式 (FA_FIXLEN)の 場 合 レコード 長 reclenを 固 定 レコード 長 として 扱 い ます レコード 形 式 が 可 変 長 形 式 (FA_VARLEN)の 場 合 レコード 長 reclenを 最 大 レコード 長 とし て 扱 います レコード 長 はFA_NRECSIZE(32760)を 超 えてはいけません レコードキーリストkeylistは ファイル 編 成 が 索 引 ファイル(FA_IDXFILE)である 場 合 にだけ 意 味 を 持 ちます この 場 合 keylistはオープンするファイルの 主 レコードキー 副 レコードキー の 構 成 として 有 効 になります struct fa_keylist 型 については struct fa_keylist を 参 照 してください 索 引 ファイルのオープンで keylistにnullポインタを 指 定 した 場 合 当 関 数 は 既 存 のファイル の 索 引 構 成 とレコード 形 式 レコード 長 を 認 識 してオープンします このとき レコード 形 式 の 指 定 とレコード 長 の 指 定 は 無 効 になります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 15

22 第 3 章 API 関 数 と 構 造 体 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 1 以 上 成 功 当 関 数 の 実 行 が 成 功 しました 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 していることがあります この 復 帰 値 は オープンに 成 功 したファイルのファイル ディスクリプタの 値 です ただし ファイルディスクリ プタはファイルのオープン 時 にOSが 返 却 したファイル ハンドルの 値 ではありませんので 注 意 してください 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました FA_ENOERR 5 不 定 ファイルが 存 在 しなかったため 仮 想 的 にファイル をオープンしました または オープンモードがINPUTモ ード(FA_INPUT) 以 外 である 場 合 ファイルを 新 規 に 創 成 しました 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_EBADACC 90 指 定 したファイル 編 成 呼 出 し 法 オープンモードの 組 合 せでは 実 行 することができません FA_EFNAME 35 ファイルが 存 在 しません FA_EFLOCKED 93 ファイルはすでに 排 他 でオープンされています FA_EFNAME 90 ファイル 名 が 正 しくありませんでした または ファイ ルへのアクセスが 失 敗 しました FA_EFNAME 91 ファイル 名 を 指 定 していません FA_EBADFLAG 39 指 定 したファイル 編 成 やレコード 形 式 などの 属 性 と 既 存 ファイルの 構 成 が 異 なっています FA_EBADKEY 39 指 定 したレコードキーの 情 報 と 既 存 の 索 引 ファイルの キーの 構 成 が 異 なっています FA_EBADKEY 90 指 定 したレコードキーの 情 報 が 正 しくありません FA_EBADLENG 39 指 定 したレコード 長 と 既 存 ファイルのレコード 長 が 異 なっています FA_EBADFILE 90 指 定 した 索 引 ファイルは 内 部 情 報 が 破 壊 しています または ファイル 編 成 が 索 引 ファイルではありません 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 16

23 3.2 ファイルのクローズ 3.2 ファイルのクローズ ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルをクローズするAPI 関 数 について 説 明 します cobfa_close() cobfa_close() ファイルをクローズします long cobfa_close ( long fd /* ファイルディスクリプタ */ ); 説 明 ファイルディスクリプタfdが 指 すファイルをクローズします 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 17

24 第 3 章 API 関 数 と 構 造 体 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 42 不 正 なファイルディスクリプタを 指 定 しています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 18

25 3.3 レコードの 読 込 み 3.3 レコードの 読 込 み ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルが 持 つレコードを 読 み 込 むAPI 関 数 について 説 明 します cobfa_rdkey() cobfa_rdnext() cobfa_rdrec() cobfa_rdkey() 任 意 のレコードキーの 値 で 示 すレコードを 読 み 込 みます ( 乱 読 込 み) long cobfa_rdkey ( long fd, /* ファイルディスクリプタ */ long readflgs, /* 読 込 み 属 性 */ char *recarea, /* レコード 域 */ const struct fa_keydesc *keydesc, /* レコードキー 構 成 指 定 */ long keynum /* レコードキー 番 号 指 定 */ ); 説 明 ファイルディスクリプタfdが 指 すファイルに 対 して レコード 域 recareaの 任 意 のレコードキー の 値 でレコードを 指 定 します 指 定 されたレコードを 読 み 込 み レコード 域 recareaに 格 納 しま す 読 込 み 属 性 readflgsの 指 定 値 には 以 下 の2つのカテゴリがあり これらをビットの 論 理 和 で 結 合 して 指 定 します これらは 省 略 可 能 です (*は 省 略 値 ) a. 読 込 みモード 記 号 定 数 意 味 * FA_EQUAL 指 定 したレコードキーの 値 に 該 当 するレコードを 読 み 込 む b. レコードロックフラグ 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_LOCK ロックありで 読 み 込 む READ WITH LOCK FA_NOLOCK ロックなしで 読 み 込 む READ WITH NO LOCK レコードロックフラグのデフォルト 値 は オープン 時 のロックモードの 指 定 により 異 なります ロックモードが 自 動 ロック(FA_AUTOLOCK)である 場 合 はデフォルト 値 がロックあり(FA_LOCK)となり それ 以 外 の 場 合 のデフォルト 値 はロックなし (FA_NOLOCK)となります 任 意 のレコードキーの 指 定 は レコードキー 構 成 指 定 keydescで 行 います struct fa_keydesc 型 については struct fa_keydesc を 参 照 してください このレコードキー 構 成 指 定 にNULLを 指 定 した 場 合 は 任 意 のレコードキーの 指 定 としてレコード キー 番 号 指 定 keynumが 有 効 になります 主 レコードキーを 指 定 するには レコードキー 番 号 指 定 に1を 指 定 します 副 レコードキーを 指 定 するには レコードキー 番 号 指 定 に2 以 上 の 値 を 指 定 し 19

26 第 3 章 API 関 数 と 構 造 体 ます この 値 は 索 引 ファイルを 創 成 したときの 副 レコードキーを 宣 言 したときの 並 びの 順 番 に 対 応 しています 最 初 の 副 レコードキーなら2を 2 番 目 の 副 レコードキーなら3を それ 以 降 もこ れらと 同 様 に 指 定 します 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は 下 表 の とおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 していることがあります 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました FA_ENOERR 2 読 み 込 んだレコードの 参 照 キーの 値 が 次 に 続 くレコー ドの 参 照 キーの 値 と 同 じです 20

27 3.3 レコードの 読 込 み 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 47 指 定 したファイルは INPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_EBADFLAG 90 当 関 数 を 実 行 することができない 読 込 みモードを 指 定 し ています または その 他 のフラグの 指 定 が 正 しくあり ません FA_ENOREC 23 任 意 のレコードキーの 値 が 示 すレコードが 存 在 しませ ん FA_EBADKEY 90 指 定 したレコードキー 構 成 またはレコードキー 番 号 は 存 在 しません または 正 しくありません FA_ELOCKED 99 主 レコードキーの 値 で 指 定 したレコードはロックされて います 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください cobfa_rdnext() レコードを 順 に 読 み 込 みます ( 順 読 込 み) long cobfa_rdnext ( long fd, /* ファイルディスクリプタ */ long readflgs, /* 読 込 み 属 性 */ char *recarea /* レコード 域 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 位 置 付 けられているレコードの 次 (または 前 )のレ コードを 読 み 込 み レコード 域 recareaに 格 納 します 読 込 み 属 性 readflgsの 指 定 値 には 以 下 の2つのカテゴリがあり これらをビットの 論 理 和 で 結 合 して 指 定 します これらは 省 略 可 能 です (*は 省 略 値 ) a. 読 込 みモード 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_NEXT 次 のレコードを 読 み 込 む READ NEXT RECORD FA_PREV 前 のレコードを 読 み 込 む READ PREVIOUS RECORD ファイル 編 成 が 以 下 のどちらかの 場 合 読 込 みモードに 前 のレコード(FA_PREV)を 指 定 することはできません 行 順 ファイル(FA_LSEQFILE) または レコード 順 ファイル(FA_SEQFILE) 21

28 第 3 章 API 関 数 と 構 造 体 b. レコードロックフラグ 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_LOCK ロックありで 読 み 込 む READ WITH LOCK FA_NOLOCK ロックなしで 読 み 込 む READ WITH NO LOCK レコードロックフラグのデフォルト 値 は オープン 時 のロックモードの 指 定 により 異 なります ロックモードが 自 動 ロック(FA_AUTOLOCK)の 場 合 は デフォルト 値 が ロックあり(FA_LOCK)となり それ 以 外 の 場 合 のデフォルト 値 はロックなし (FA_NOLOCK)となります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です ただし ファイルの 位 置 付 けが 不 定 でないことが 必 須 条 件 とな ります : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 していることがあります 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました FA_ENOERR 2 読 み 込 んだレコードの 参 照 キーの 値 が 次 に 続 くレコー ドの 参 照 キーの 値 と 同 じです 22

29 3.3 レコードの 読 込 み 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 47 指 定 したファイルは INPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています FA_EBADACC 90 当 関 数 を 実 行 することができない 呼 出 し 法 で ファイル がオープンしてあります FA_EENDFILE 10 ファイル 終 了 条 件 が 発 生 しました FA_EBADFLAG 90 当 関 数 を 実 行 することができない 読 込 みモードを 指 定 し ています または その 他 のフラグの 指 定 が 正 しくあり ません FA_ENOCURR 46 レコードへの 位 置 付 けが 不 定 でした FA_ELOCKED 99 順 読 込 みによって 位 置 付 けようとしたレコードはすでに ロックされています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください cobfa_rdrec() 相 対 レコード 番 号 が 示 すレコードを 読 み 込 みます ( 乱 読 込 み) long cobfa_rdrec ( long fd, /* ファイルディスクリプタ */ long readflgs, /* 読 込 み 属 性 */ char *recarea, /* レコード 域 */ unsigned long recnum /* 相 対 レコード 番 号 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 相 対 レコード 番 号 recnumが 指 すレコードを 読 み 込 み レコード 域 recareaに 格 納 します 読 込 み 属 性 readflgsの 指 定 値 には 以 下 の2つのカテゴリがあり これらをビットの 論 理 和 で 結 合 して 指 定 します これらは 省 略 可 能 です (*は 省 略 値 ) a. 読 込 みモード 記 号 定 数 意 味 * FA_EQUAL 指 定 した 相 対 レコード 番 号 のレコードを 読 み 込 む 23

30 第 3 章 API 関 数 と 構 造 体 b. レコードロックフラグ 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_LOCK ロックありで 読 み 込 む READ WITH LOCK FA_NOLOCK ロックなしで 読 み 込 む READ WITH NO LOCK レコードロックフラグのデフォルト 値 は オープン 時 のロックモードの 指 定 により 異 なります ロックモードが 自 動 ロック(FA_AUTOLOCK)の 場 合 は デフォルト 値 が ロックあり(FA_LOCK)となり それ 以 外 の 場 合 のデフォルト 値 はロックなし (FA_NOLOCK)となります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は 下 表 の とおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 24

31 3.3 レコードの 読 込 み ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 47 指 定 したファイルは INPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 で ファイルがオープンしてあります FA_EBADFLAG 90 当 関 数 を 実 行 することができない 読 込 みモードを 指 定 し ています または その 他 のフラグの 指 定 が 正 しくあり ません FA_ENOREC 23 相 対 レコード 番 号 が 示 すレコードが 存 在 しません FA_ELOCKED 99 相 対 レコード 番 号 で 指 定 したレコードはロックされてい ます 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 25

32 第 3 章 API 関 数 と 構 造 体 3.4 レコードの 書 出 し ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルにレコードを 書 き 出 すAPI 関 数 について 説 明 しま す cobfa_wrkey() cobfa_wrnext() cobfa_wrrec() cobfa_wrkey() 主 レコードキーの 値 で 指 定 したレコードを 書 き 出 します ( 乱 書 出 し) long cobfa_wrkey ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen /* 書 出 しレコード 長 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで レコード 域 recareaが 持 つ 主 レコードキーの 値 が 指 すレコードを レコード 域 が 持 つ 内 容 で 書 き 出 します ファイルが 可 変 長 形 式 であるときだけ 書 出 しレコード 長 reclenが 有 効 になります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 26

33 3.4 レコードの 書 出 し 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_EDUPL 22 書 出 ししようとしたレコードの 主 レコードキーまたは 副 レコードキーの 値 が すでにファイル 中 に 存 在 していま す しかし 主 レコードキーまたは 副 レコードキーは 重 複 を 許 可 していません FA_EBADLENG 44 指 定 した 書 出 しレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています FA_ENOTOPEN 48 指 定 したファイルは OUTPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください cobfa_wrnext() レコードを 順 に 書 き 出 します ( 順 書 出 し) long cobfa_wrnext ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen /* 書 出 しレコード 長 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで レコード 域 recareaが 持 つ 内 容 で レコードを 順 に 書 き 出 します ファイルが 可 変 長 形 式 の 場 合 だけ 書 出 しレコード 長 reclenが 有 効 になります 27

34 第 3 章 API 関 数 と 構 造 体 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_EDUPL 22 書 き 出 そうとしたレコードの 主 レコードキーまたは 副 レ コードキーの 値 がすでにファイル 中 に 存 在 しています しかし 主 レコードキーまたは 副 レコードキーは 重 複 を 許 可 していません FA_EBADLENG 44 指 定 した 書 出 しレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています FA_ENOTOPEN 48 指 定 したファイルは OUTPUTモード 以 外 かつ EXTEND モード 以 外 でオープンしてあります または 不 正 なフ ァイルディスクリプタを 指 定 しています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 28

35 3.4 レコードの 書 出 し cobfa_wrrec() 相 対 レコード 番 号 で 指 定 したレコードを 書 き 出 します ( 乱 書 出 し) long cobfa_wrrec ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen, /* 書 出 しレコード 長 */ unsigned long recnum /* 相 対 レコード 番 号 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 相 対 レコード 番 号 recnumが 指 すレコードを レコ ード 域 recareaが 持 つ 内 容 で 書 き 出 します ファイルが 可 変 長 形 式 の 場 合 だけ 書 出 しレコード 長 reclenが 有 効 になります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 29

36 第 3 章 API 関 数 と 構 造 体 ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_EDUPL 22 すでに 存 在 する 相 対 レコード 番 号 を 使 って 書 出 しを 行 お うとしました FA_EBADLENG 44 指 定 した 書 出 しレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています FA_ENOTOPEN 48 指 定 したファイルは OUTPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 30

37 3.5 レコードの 削 除 3.5 レコードの 削 除 ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルが 持 つレコードを 削 除 するAPI 関 数 について 説 明 します cobfa_delcurr() cobfa_delkey() cobfa_delrec() cobfa_delcurr() 順 読 込 みしたレコードを 削 除 します ( 順 削 除 ) long cobfa_delcurr ( long fd /* ファイルディスクリプタ */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 順 読 込 みによって 位 置 付 けられているレコード (カレントレコード)を 削 除 します 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です ただし レコードが 順 読 込 みによって 位 置 付 けら れていること が 必 須 条 件 となります : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 31

38 第 3 章 API 関 数 と 構 造 体 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 49 指 定 したファイルは IOモード 以 外 でオープンしてあり ます または 不 正 なファイルディスクリプタを 指 定 し ています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_ELOCKED 99 順 読 込 みによって 位 置 付 けられているレコードはロック されています FA_ENOCURR 43 指 定 したファイルでの 順 読 込 みが 成 功 していませんでし た 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください cobfa_delkey() 主 レコードキーの 値 が 示 すレコードを 削 除 します ( 乱 削 除 ) long cobfa_delkey ( long fd, /* ファイルディスクリプタ */ const char *recarea /* レコード 域 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで レコード 域 recareaの 内 容 が 持 つ 主 レコードキー の 値 が 指 すレコードを 削 除 します 32

39 3.5 レコードの 削 除 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 49 指 定 したファイルは IOモード 以 外 でオープンしてあり ます または 不 正 なファイルディスクリプタを 指 定 し ています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_ELOCKED 99 主 レコードキーの 値 で 指 定 したレコードはロックされて います FA_ENOREC 23 主 レコードキーの 値 で 指 定 したレコードは 存 在 しませ ん 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 33

40 第 3 章 API 関 数 と 構 造 体 cobfa_delrec() 相 対 レコード 番 号 が 示 すレコードを 削 除 します ( 乱 削 除 ) long cobfa_delrec ( long fd, /* ファイルディスクリプタ */ unsigned long recnum /* 相 対 レコード 番 号 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 相 対 レコード 番 号 recnumが 指 すレコードを 削 除 し ます 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 34

41 3.5 レコードの 削 除 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 49 指 定 したファイルは IOモード 以 外 でオープンしてあり ます または 不 正 なファイルディスクリプタを 指 定 し ています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_ELOCKED 99 相 対 レコード 番 号 で 指 定 したレコードはロックされてい ます FA_ENOREC 23 相 対 レコード 番 号 で 指 定 したレコードは 存 在 しません 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 35

42 第 3 章 API 関 数 と 構 造 体 3.6 レコードの 書 換 え ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルが 持 つレコードを 書 き 換 えるAPI 関 数 について 説 明 します cobfa_rewcurr() cobfa_rewkey() cobfa_rewrec() cobfa_rewcurr() 順 読 込 みしたレコードを 書 き 換 えます ( 順 更 新 ) long cobfa_rewcurr ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen /* 書 換 えレコード 長 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで 順 読 込 みによって 位 置 付 けられているレコード (カレントレコード)を レコード 域 recareaの 内 容 で 書 き 換 えます ファイルが 可 変 長 形 式 であるときだけ 書 換 えレコード 長 reclenの 指 定 が 有 効 になります ファ イル 編 成 がレコード 順 ファイル(FA_SEQFILE)のときは 元 のレコード 長 を 変 えることはできませ ん 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です ただし レコードが 順 読 込 みによって 位 置 付 けら れていること が 必 須 条 件 となります : 当 関 数 の 実 行 はできません 36

43 3.6 レコードの 書 換 え 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_EDUPL 22 書 き 換 えようとしたレコードの 主 レコードキーまたは 副 レコードキーの 値 がすでにファイル 中 に 存 在 していま す しかし 主 レコードキーまたは 副 レコードキーは 重 複 を 許 可 していません FA_EBADLENG 44 指 定 した 書 換 えレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています 注 この 表 にあるステータス 以 外 に 発 生 するものは cobfa_delcurr() の 発 生 する ステータスを 参 照 してください cobfa_rewkey() 主 レコードキーの 値 が 示 すレコードを 書 き 換 えます ( 乱 更 新 ) long cobfa_rewkey ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen /* 書 換 えレコード 長 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルの レコード 域 recareaの 中 に 持 つ 主 レコードキーの 値 が 指 すレコードを レコード 域 recareaの 内 容 で 書 き 換 えます ファイルが 可 変 長 形 式 であるときだけ 書 換 えレコード 長 reclenの 指 定 が 有 効 になります 37

44 第 3 章 API 関 数 と 構 造 体 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 関 数 の 実 行 の 失 敗 時 ( 注 ) エラー 番 号 入 出 力 状 態 説 明 FA_EDUPL 22 重 複 を 許 可 していないレコードキーに 対 して すでに 存 在 するレコードキーの 値 を 持 つレコード 内 容 で 書 き 換 え ようとしました FA_EBADLENG 44 指 定 した 書 換 えレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています 注 この 表 にあるステータス 以 外 に 発 生 するものは cobfa_delkey() の 発 生 するス テータスを 参 照 してください 38

45 3.6 レコードの 書 換 え cobfa_rewrec() 相 対 レコード 番 号 が 示 すレコードを 書 き 換 えます ( 乱 更 新 ) long cobfa_rewrec ( long fd, /* ファイルディスクリプタ */ const char *recarea, /* レコード 域 */ long reclen, /* 書 換 えレコード 長 */ unsigned long recnum /* 相 対 レコード 番 号 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルの 相 対 レコード 番 号 recnumのレコードを レコード 域 recareaの 内 容 で 書 き 換 えます ファイルが 可 変 長 形 式 であるときだけ 書 換 えレコード 長 reclenの 指 定 が 有 効 になります 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 39

46 第 3 章 API 関 数 と 構 造 体 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_EBADLENG 44 指 定 した 書 換 えレコード 長 の 値 が 指 定 可 能 な 範 囲 を 超 え ています 注 この 表 にあるステータス 以 外 に 発 生 するものは cobfa_delrec() の 発 生 するス テータスを 参 照 してください 40

47 3.7 レコードの 位 置 決 め 3.7 レコードの 位 置 決 め ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルが 持 つレコードをアクセスする 位 置 を 決 めるAPI 関 数 について 説 明 します cobfa_stkey() cobfa_strec() cobfa_stkey() 任 意 のレコードキーの 値 が 示 すレコードに 位 置 付 けます long cobfa_stkey ( long fd, /* ファイルディスクリプタ */ long stflgs, /* 位 置 付 け 属 性 */ const char *recarea, /* レコード 域 */ const struct fa_keydesc *keydesc, /* レコードキー 構 成 指 定 */ long keynum, /* レコードキー 番 号 指 定 */ long keyleng /* 有 効 キー 長 */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで レコード 域 recareaの 中 に 持 つ 任 意 のレコードキ ーの 値 に 関 連 するレコードに 位 置 付 けを 行 います また 指 定 した 任 意 のレコードキーを 以 降 の 順 読 込 みでの 参 照 キーとして 宣 言 します 位 置 付 け 属 性 stflgsの 指 定 値 には 以 下 の2つのカテゴリがあり これらをビットの 論 理 和 で 結 合 して 指 定 します これらは 省 略 可 能 です (*は 省 略 値 ) a. 位 置 付 けモード 記 号 定 数 意 味 対 応 するCOBOL 構 文 FA_FIRST 先 頭 レコード START FIRST RECORD * FA_EQUAL レコードキーの 値 と START KEY IS = 等 しいレコード FA_GREAT レコードキーの 値 を START KEY IS > 超 えるレコード FA_GTEQ レコードキーの 値 以 START KEY IS >= 上 のレコード FA_LESS レコードキーの 値 よ START KEY IS < り 小 さいレコード FA_LTEQ レコードキーの 値 以 下 のレコード START KEY IS <= 41

48 第 3 章 API 関 数 と 構 造 体 b. 逆 順 読 込 みフラグ 記 号 定 数 意 味 対 応 するCOBOL 構 文 * なし 順 読 込 み 時 に 論 理 的 に 順 方 向 に 読 み 込 む FA_REVORD 順 読 込 み 時 に 論 理 的 に 逆 方 向 に 読 み 込 む START WITH REVERSED ORDER 逆 順 読 込 みフラグのデフォルト 値 は 正 順 読 込 みになります 位 置 付 けモードがレコードキーの 値 を 超 過 (FA_GREAT)またはレコードキーの 値 以 上 (FA_GTEQ)の 場 合 逆 順 読 込 みフラグ(FA_REVORD)を 指 定 することはできません 逆 順 読 込 みフラグの 指 定 は 乱 読 込 み 位 置 付 け ファイルのクローズを 行 ったり ファイル 終 了 条 件 が 発 生 したりすることで 無 効 になります 任 意 のレコードキーの 指 定 は レコードキー 構 成 指 定 keydescで 行 います struct fa_keydesc 型 については struct fa_keydesc を 参 照 してください このレコードキー 構 成 指 定 にNULLを 指 定 した 場 合 は 任 意 のレコードキーの 指 定 としてレコード キー 番 号 指 定 keynumが 有 効 になります 主 レコードキーを 指 定 するには レコードキー 番 号 指 定 に1を 指 定 します 副 レコードキーを 指 定 するには レコードキー 番 号 指 定 に2 以 上 の 値 を 指 定 し ます この 値 は 索 引 ファイルを 創 成 したときの 副 レコードキーを 宣 言 したときの 並 びの 順 番 に 対 応 しています 最 初 の 副 レコードキーなら2を 2 番 目 の 副 レコードキーなら3を それ 以 上 もこ れらと 同 様 に 指 定 します 有 効 キー 長 keylengは 有 効 な 参 照 キーの 長 さを 短 くするために 使 います 有 効 な 参 照 キーの 長 さを 短 くしない 通 常 の 場 合 は 0を 指 定 します この 場 合 任 意 のレコードキーの 全 体 が 参 照 キ ーとなります 有 効 な 参 照 キーの 長 さを 短 くする 場 合 は 1 以 上 の 値 を 指 定 します この 値 は キーパートの 並 びを 連 続 した 先 頭 からのキーの 長 さをバイト 単 位 で 指 定 します 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 42

49 3.7 レコードの 位 置 決 め 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 47 指 定 したファイルは INPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_EBADFLAG 90 当 関 数 を 実 行 することができない 位 置 付 けモードを 指 定 しています または その 他 のフラグの 指 定 が 正 しくあ りません FA_ENOREC 23 指 定 した 条 件 に 該 当 するレコードが 存 在 しませんでし た FA_EBADKEY 90 指 定 したレコードキー 構 成 またはレコードキー 番 号 は 存 在 しません または 正 しくありません 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください cobfa_strec() 相 対 レコード 番 号 が 示 すレコードに 位 置 付 けます long cobfa_strec ( long fd, /* ファイルディスクリプタ */ long stflgs, /* 位 置 付 け 属 性 */ unsigned long recnum /* 相 対 レコード 番 号 */ ); 43

50 第 3 章 API 関 数 と 構 造 体 説 明 ファイルディスクリプタfdが 示 すファイルで 相 対 レコード 番 号 recnumの 値 に 関 連 するレコード に 位 置 付 けを 行 います 位 置 付 け 属 性 stflgsの 指 定 値 には 以 下 の1つのカテゴリがあります これは 省 略 可 能 です (*は 省 略 値 ) a. 位 置 付 けモード 記 号 定 数 意 味 対 応 するCOBOL 構 文 * FA_EQUAL recnumと 等 しいレコード START KEY IS = FA_GREAT recnumを 超 えるレコード START KEY IS > FA_GTEQ recnum 以 上 のレコード START KEY IS >= FA_LESS recnumより 小 さいレコード START KEY IS < FA_LTEQ recnum 以 下 のレコード START KEY IS <= 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 44

51 3.7 レコードの 位 置 決 め ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 47 指 定 したファイルは INPUTモード 以 外 かつ IOモー ド 以 外 でオープンしてあります または 不 正 なファイ ルディスクリプタを 指 定 しています FA_EBADACC 90 当 関 数 を 実 行 することができないファイル 編 成 または 呼 出 し 法 でファイルがオープンしてあります FA_EBADFLAG 90 当 関 数 を 実 行 することができない 位 置 付 けモードを 指 定 しています または その 他 のフラグの 指 定 が 正 しくあ りません FA_ENOREC 23 指 定 した 条 件 に 該 当 するレコードが 存 在 しませんでし た 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 45

52 第 3 章 API 関 数 と 構 造 体 3.8 レコードロックの 解 除 ここでは 入 出 力 機 能 のAPI 関 数 のうち ファイルが 持 つロック 中 のレコードをロック 解 除 するAPI 関 数 について 説 明 します cobfa_release() cobfa_release() 指 定 するファイルのすべてのレコードロックを 解 除 します long cobfa_release ( long fd /* ファイルディスクリプタ */ ); 説 明 ファイルディスクリプタfdが 示 すファイルで すべてのレコードロックを 解 除 します 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 46

53 3.8 レコードロックの 解 除 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました ( 注 ) 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 90 ファイルのオープン 時 に 取 得 したものでない 不 正 なファ イルディスクリプタを 指 定 しています 注 これらは 代 表 的 なステータスです これ 以 外 のステータスについては 4.1 エラー 番 号 と 4.2 入 出 力 状 態 を 参 照 してください 47

54 第 3 章 API 関 数 と 構 造 体 3.9 ファイル 情 報 の 取 得 ここでは ファイルの 情 報 を 取 得 する 機 能 を 持 つAPI 関 数 について 説 明 します cobfa_indexinfo() cobfa_indexinfo() 索 引 ファイルの 属 性 またはレコードキーの 構 成 を 取 得 します long cobfa_indexinfo ( long fd, /* ファイルディスクリプタ */ struct fa_keydesc *buffer, /* 取 得 結 果 の 格 納 域 */ long funccode /* 機 能 コード */ ); 説 明 ファイルディスクリプタfdが 示 す 索 引 ファイルに 関 する 情 報 を 取 得 結 果 の 格 納 域 buffer 内 に 設 定 します 取 得 する 情 報 の 種 類 は 機 能 コードfunccodeへの 指 定 で 選 択 します 機 能 コードに0を 指 定 すると 取 得 結 果 の 格 納 域 にstruct fa_dictinfo 型 でファイルの 属 性 を 格 納 します struct fa_dictinfo 型 については struct fa_dictinfo を 参 照 してくだ さい 機 能 コードに1 以 上 を 指 定 すると 取 得 結 果 の 格 納 域 にstruct fa_keydesc 型 で 主 レコードキーま たは 副 レコードキーの 構 成 を 格 納 します 機 能 コードの 値 に1を 指 定 するとき 主 レコードキーの 構 成 を 取 得 し 2 以 上 では 副 レコードキーの 構 成 を 取 得 します この 値 は 索 引 ファイルを 創 成 したときの 副 レコードキーを 宣 言 したときの 並 びの 順 番 に 対 応 し ています 最 初 の 副 レコードキーなら2を 2 番 目 の 副 レコードキーなら3を これ 以 降 もこれら と 同 様 に 指 定 します struct fa_keydesc 型 については struct fa_keydesc を 参 照 してください 実 行 可 能 な 条 件 当 関 数 の 機 能 を 実 行 することができるファイル 編 成 オープンモードおよび 呼 出 し 法 は それぞ れ 下 表 のとおりです オープン 属 性 種 別 実 行 の 可 否 ファイル 編 成 行 順 ファイル レコード 順 ファイル 相 対 ファイル オープンモード 呼 出 し 法 索 引 ファイル INPUTモード OUTPUTモード IOモード EXTENDモード 順 呼 出 し 乱 呼 出 し 動 的 呼 出 し : 当 関 数 の 実 行 が 可 能 です : 当 関 数 の 実 行 はできません 48

55 3.9 ファイル 情 報 の 取 得 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 当 関 数 の 実 行 が 成 功 しました 1 失 敗 当 関 数 の 実 行 が 失 敗 しました エラー 番 号 と 入 出 力 状 態 が 状 況 を 示 すコードを 保 持 しています 発 生 するステータス 当 関 数 の 呼 出 しによって 発 生 するステータスは 下 表 のようになります 関 数 の 実 行 の 成 功 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOERR 0 関 数 の 実 行 は 成 功 しました 関 数 の 実 行 の 失 敗 時 エラー 番 号 入 出 力 状 態 説 明 FA_ENOTOPEN 90 不 正 なファイルディスクリプタを 指 定 しています FA_EBADACC 90 指 定 したファイルは 索 引 ファイルでありません 49

56 第 3 章 API 関 数 と 構 造 体 3.10 エラー 番 号 の 取 得 ここでは 入 出 力 の 状 況 を 取 得 する 機 能 のAPIのうち エラー 番 号 の 取 得 を 行 うAPI 関 数 について 説 明 します cobfa_errno() cobfa_errno() エラー 番 号 を 返 却 します long cobfa_errno ( void /* 引 数 なし */ ); 説 明 入 出 力 のAPI 関 数 またはファイル 情 報 取 得 のAPI 関 数 を 実 行 した 結 果 起 こったエラーを 識 別 する 番 号 を 返 却 します 実 行 可 能 な 条 件 つねに 呼 出 し 可 能 復 帰 値 当 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 FA_ENOERR 成 功 入 出 力 機 能 の 実 行 またはファイル 情 報 取 得 の 実 行 が 成 功 したことを 意 味 します FA_ENOERR 以 外 失 敗 入 出 力 機 能 の 実 行 またはファイル 情 報 取 得 の 実 行 が 失 敗 したことを 意 味 します ( 注 1) 注 1 復 帰 値 の 詳 細 については 4.1 エラー 番 号 を 参 照 してください 50

57 3.11 入 出 力 状 態 の 取 得 3.11 入 出 力 状 態 の 取 得 ここでは 入 出 力 の 状 況 を 取 得 する 機 能 のAPIのうち 入 出 力 状 態 の 取 得 を 行 うAPI 関 数 について 説 明 します cobfa_stat() cobfa_stat() 入 出 力 状 態 を 返 却 します long cobfa_stat ( void /* 引 数 なし */ ); 説 明 入 出 力 のAPI 関 数 またはファイル 情 報 取 得 のAPI 関 数 を 実 行 した 結 果 の 入 出 力 状 態 を 返 却 します 実 行 可 能 な 条 件 つねに 呼 出 し 可 能 復 帰 値 入 出 力 状 態 を 返 却 します 入 出 力 状 態 の 種 類 とその 詳 細 については NetCOBOL 使 用 手 引 書 の 付 録 B 入 出 力 状 態 一 覧 を 参 照 してください 51

58 第 3 章 API 関 数 と 構 造 体 3.12 読 込 みレコード 長 の 取 得 ここでは 入 出 力 の 状 況 を 取 得 する 機 能 のAPIのうち 読 込 みレコード 長 の 取 得 を 行 うAPI 関 数 に ついて 説 明 します cobfa_reclen() cobfa_reclen() レコード 長 を 返 却 します long cobfa_reclen ( void /* 引 数 なし */ ); 説 明 レコード 形 式 が 可 変 長 であるファイルを 扱 うとき 入 出 力 のAPI 関 数 のうち 以 下 の 関 数 の 実 行 が 成 功 したあと 読 み 込 んだレコードの 実 際 の 長 さを 返 却 します 読 込 み 失 敗 や 他 の 入 出 力 機 能 の 実 行 後 は 不 定 な 値 を 返 却 します cobfa_rdnext() cobfa_rdrec() cobfa_rdkey() 実 行 可 能 な 条 件 つねに 呼 出 し 可 能 復 帰 値 読 み 込 んだレコードの 長 さ(バイト 数 ) 52

59 3.13 相 対 レコード 番 号 の 取 得 3.13 相 対 レコード 番 号 の 取 得 ここでは 入 出 力 の 状 況 を 取 得 する 機 能 のAPIのうち 相 対 レコード 番 号 の 取 得 を 行 うAPI 関 数 に ついて 説 明 します cobfa_recnum() cobfa_recnum() 相 対 レコード 番 号 を 返 却 します unsigned long cobfa_recnum ( void /* 引 数 なし */ ); 説 明 相 対 ファイルで 入 出 力 のAPI 関 数 のうち 以 下 の 関 数 の 実 行 が 成 功 したあと 現 在 位 置 付 けら れているレコードの 相 対 レコード 番 号 を 返 却 します cobfa_rdnext() cobfa_rdrec() 読 込 みが 失 敗 した 後 や 相 対 ファイル 以 外 のファイル 編 成 での 入 出 力 機 能 の 実 行 後 には 不 定 な 値 を 返 却 します 実 行 可 能 な 条 件 つねに 呼 出 し 可 能 復 帰 値 相 対 ファイルで 現 在 位 置 付 けられている 相 対 レコード 番 号 53

60 第 3 章 API 関 数 と 構 造 体 3.14 マルチスレッド 環 境 下 での 排 他 制 御 マルチスレッド 環 境 下 では 複 数 のスレッドが 同 時 にCOBOLランタイムシステムによるファイル アクセスを 行 わないように 排 他 制 御 する 必 要 があります ここでは その 排 他 制 御 を 行 うため の 以 下 の 関 数 について 説 明 します LOCK_cobfa() UNLOCK_cobfa() LOCK_cobfa() マルチスレッド 環 境 下 でのCOBOLファイルアクセスに 排 他 ロックをかけます long LOCK_cobfa ( const unsigned long *timeout, /* 待 ち 時 間 */ unsigned long *errcode /* エラーコード */ ); 説 明 他 のスレッドが 同 時 にCOBOLファイルへのアクセスを 行 わないように COBOLランタイムシステム が 行 うファイルアクセスに 対 して 排 他 ロックをかけます マルチスレッド 環 境 下 でファイルへの アクセスを 行 う 場 合 競 合 による 問 題 を 発 生 させないために この 関 数 を 呼 び 出 す 必 要 がありま す 待 ち 時 間 timeoutにはミリ 秒 単 位 の 値 を 持 つ 長 整 数 型 へのポインタを 指 定 します もし 他 のスレ ッドが 先 に 排 他 ロックをかけているとき 当 スレッドでの 関 数 の 呼 出 しからtimeoutまでの 間 に 排 他 ロックが 解 除 されないと 関 数 の 実 行 は 失 敗 します timeoutにnullを 指 定 した 場 合 待 ち 時 間 は 無 制 限 となります 当 関 数 の 復 帰 値 が1であるとき エラーコード*errcodeにWindowsシステムエラーコードを 設 定 します ただし errcodeにnullを 設 定 した 場 合 には エラーコードを 設 定 しません 当 関 数 の 復 帰 値 が1でない 場 合 の 値 は 不 定 です 実 行 可 能 な 条 件 つねに 呼 出 し 可 能 復 帰 値 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 COBOLファイルアクセスの 排 他 ロックが 成 功 しました 1 COBOLファイルアクセスの 排 他 ロックが 成 功 しました 排 他 ロックをしていた 他 のスレッドがロックを 解 除 しない で 終 了 したため 代 わりに 当 スレッドがロック 制 御 権 を 得 ました 他 のスレッドが 異 常 な 終 了 をしている 可 能 性 がありますので 処 理 を 継 続 する 際 には 十 分 な 注 意 が 必 要 です 1 失 敗 システムエラーが 発 生 しました この 場 合 エラーコー ド*errcodeにWindowsシステムエラーコードが 設 定 され ます 2 待 ち 時 間 timeoutを 超 えました 排 他 ロックをかけません でした 54

61 3.14 マルチスレッド 環 境 下 での 排 他 制 御 使 い 方 当 関 数 は 入 出 力 機 能 を 持 つAPI 関 数 か ファイルの 情 報 を 取 得 するAPI 関 数 の 前 に 呼 びます API 関 数 呼 出 し に 続 け て 状 況 を 取 得 す る API 関 数 を 必 要 に 応 じ て 呼 ん だ 後 UNLOCK_cobfa() を 呼 びます 状 況 を 取 得 する 関 数 の 呼 出 しは 入 出 力 かファイル 情 報 の 取 得 のAPI 関 数 呼 出 しとともに 必 ず 一 回 の 排 他 ロック 中 に 行 ってください 数 回 の 排 他 制 御 に 分 けて 状 況 を 取 得 すると 状 況 を 示 す 値 が 他 のスレッドで 上 書 きされ 正 しくない 可 能 性 があります 以 下 に1つの 入 出 力 ごとに 排 他 制 御 を 行 う 例 を 示 します long ret, fd, eno, stat, recnum; ret = LOCK_cobfa ( NULL, NULL ); /* ファイルアクセスを 排 他 ロックする */ if ( ret < 0 ) {... /* エラー 処 理 */ } fd = cobfa_open ( "file.rel", FA_INPUT FA_RELFILE FA_FIXED, 10 ); stat = cobfa_stat ( ); eno = cobfa_errno ( ); UNLOCK_cobfa ( NULL ); /* ファイルアクセスの 排 他 ロックを 解 除 する */ if ( eno == FA_EFNAME ) { printf ( "errno: %d, stat: %d\n", eno, stat );... }... /* ファイル 入 出 力 に 関 係 のないさまざまな 処 理 を 行 う */ ret = LOCK_cobfa ( NULL, NULL ); /* ファイルアクセスを 排 他 ロックする */ if ( ret < 0 ) {... /* エラー 処 理 */ } cobfa_rdnext ( fd, FA_NEXT, buff ); recnum = cobfa_recnum ( ); UNLOCK_cobfa ( NULL ); /* ファイルアクセスの 排 他 ロックを 解 除 する */ num = recnum;... /* ファイル 入 出 力 に 関 係 のないさまざまな 処 理 を 行 う */ ret = LOCK_cobfa ( NULL, NULL ); /* ファイルアクセスを 排 他 ロックする */ if ( ret < 0 ) {... /* エラー 処 理 */ } cobfa_close ( fd ); UNLOCK_cobfa ( NULL ); /* ファイルアクセスの 排 他 ロックを 解 除 する */ また 最 初 にCOBOLファイルへのアクセスを 始 めてから 最 後 にアクセスが 終 わるまでの 間 排 他 制 御 をすることもできます このように 排 他 制 御 を 行 う 範 囲 は 任 意 に 広 げることができます 55

62 第 3 章 API 関 数 と 構 造 体 以 下 の 図 に まとめて 排 他 制 御 を 行 う 例 を 示 します long ret, fd; ret = LOCK_cobfa ( NULL, NULL ); /* ファイルアクセスを 排 他 ロックする */ if ( ret < 0 ) {... /* エラー 処 理 */ } fd = cobfa_open ( "file.seq", FA_OUTPUT FA_SEQFILE FA_FIXED, 10 ); cobfa_wrnext ( fd, buffer, 10 );... /* その 他 ファイルに 対 する 入 出 力 を 行 う */ cobfa_close ( fd ); UNLOCK_cobfa ( NULL ); /* ファイルアクセスの 排 他 ロックを 解 除 する */ UNLOCK_cobfa() マルチスレッド 環 境 下 でのファイルアクセスに 排 他 ロックを 解 除 します long UNLOCK_cobfa ( unsigned long *errcode /* エラーコード */ ); 説 明 COBOLランタイムシステムのファイルアクセスにかけていた 排 他 ロックを 解 除 します 当 関 数 の 復 帰 値 が1であるとき エラーコード*errcodeにWindowsシステムエラーコードを 設 定 します ただし errcodeにnullを 設 定 した 場 合 エラーコードを 設 定 しません 当 関 数 の 復 帰 値 が1でない 場 合 の 値 は 不 定 です 実 行 可 能 な 条 件 つねに 呼 び 出 し 可 能 復 帰 値 関 数 の 復 帰 値 は 下 表 のようになります 復 帰 値 状 態 説 明 0 成 功 COBOLファイルアクセスの 排 他 ロックの 解 除 が 成 功 しま した 1 失 敗 システムエラーが 発 生 しました この 場 合 エラーコー ド*errcodeにWindowsシステムエラーコードが 設 定 され ます 56

63 3.15 使 用 する 構 造 体 3.15 使 用 する 構 造 体 ここでは API 関 数 が 使 用 する 構 造 体 について 説 明 します struct fa_keydesc struct fa_keylist struct fa_dictinfo struct fa_keydesc cobfa_rdkey() 関 数 とcobfa_stkey() 関 数 では 任 意 のレコードキーの 選 択 をstruct fa_keydesc 型 で 指 定 できます cobfa_indexinfo() 関 数 は オープンしてある 索 引 ファイルの 任 意 のレコードキーの 構 成 を 知 る ことができます ここでは レコードキーの 構 成 を 与 えるstruct fa_keydesc 型 のメンバと 設 定 する/ 格 納 される 値 について 説 明 します #define FA_NPARTS 254u /* max number of key parts */ struct fa_keydesc { long k_flags; /* flags (duplicatable or not) */ long k_nparts; /* number of parts in key */ struct fa_keypart k_part [FA_NPARTS]; /* each key part */ }; レコードキーの 属 性 を 示 すk_flagsには 以 下 の 値 が 入 ります FA_DUPS: このレコードキーは 重 複 可 能 FA_NODUPS: このレコードキーは 重 複 を 許 可 しない k_npartsには レコードキーの 中 のパート(キーパート)の 数 が 入 ります キーパート 数 の 最 小 値 は1で 最 大 値 はFA_NPARTS(254)です 個 々のキーパートの 情 報 を 持 つk_partは struct fa_keypart 型 の 配 列 で 宣 言 しています 以 下 で 説 明 します #define FA_NRECSIZE 32760u /* max number of bytes in a record */ #define FA_NKEYSIZE 254u /* max number of bytes in a key */ struct fa_keypart { short kp_start; /* starting byte of key part */ short kp_leng; /* length in bytes */ long kp_flags; /* flags (UCS2 key part or not) */ }; kp_startには レコードの 先 頭 位 置 を0とするバイト 単 位 の 変 位 を 設 定 します この 変 位 の 最 大 値 はFA_NRECSIZE1(32759)です 57

64 第 3 章 API 関 数 と 構 造 体 kp_lengには キーパートの 長 さを 設 定 します この 長 さの 最 小 値 は1で 上 位 制 限 値 は FA_NKEYSIZE(254)です 変 位 と 長 さの 和 がFA_NRECSIZE(32760)を 超 えてはいけません kp_flagsには 以 下 の1つのカテゴリの 情 報 を 設 定 します このメンバへの 設 定 値 は ファイル のオープン(cobfa_open() 関 数 )のオープン 属 性 引 数 にキーパートフラグ 使 用 指 定 (FA_USEKPFLAGS)を 指 定 したときだけ 有 効 になります キーパートのコード 系 種 別 記 号 定 数 説 明 FA_UCS2KPCODE キーパートのコード 系 種 別 はUCS2(リトルエンディアン)である FA_ANYKPCODE キーパートのコード 系 種 別 は 上 記 以 外 である 動 作 モードがUnicodeのCOBOLアプリケーションで 扱 う 索 引 ファイルで キーパートがUCS2(リト ルエンディアン)の 日 本 語 項 目 であるときに FA_UCS2KPCODEを 設 定 します キーパートが UCS2(リトルエンディアン)の 日 本 語 項 目 でないときや 動 作 モードがUnicodeでないときには FA_ANYKPCODEを 指 定 します レコードキーの 構 成 の 取 得 (cobfa_indexinfo() 関 数 )でkp_flagsを 参 照 するときには マスク 値 FA_KPCODEMASKを 用 いてキーパートのコード 系 種 別 を 取 り 出 してください FA_KPCODEMASKの 使 用 例 #include "f6agfcfa.h" #define GET_PRIM_KEY 1 struct fa_keydesc keydesc1; : ret = cobfa_indexinfo ( fd, &keydesc1, GET_PRIM_KEY ); for ( i = 0; i < keydesc1.k_nparts; i ++ ) { : switch ( keydesc1.k_part[i].kp_flags & FA_KPCODEMASK ) { case FA_UCS2KPCODE: : break; case FA_ANYKPCODE: : break; } : } 設 定 例 具 体 的 な 設 定 例 としてa.とb.の2つを 挙 げます 58

65 3.15 使 用 する 構 造 体 a. 具 体 的 な 設 定 例 主 レコードキーは 重 複 可 能 キーパートは2つ 最 初 のキーパートは 先 頭 から5バイト 目 にあり 長 さは3 次 のキーパートは 先 頭 から11バイト 目 にあり 長 さは5 バイト 目 変 位 ============================================================ 最 初 のパート 次 のパート part1 part2 COBOLで 記 述 した 場 合 の 参 考 例 : : ENVIRONMENT DIVISION CONFIGURATION SECTION INPUTOUTPUT SECTION FILECONTROL SELECT FILENAME1 ASSIGN TO SYS ORGANIZATION IS INDEXED RECORD KEY IS PART1 PART2 WITH DUPLICATES DATA DIVISION FILE SECTION FD FILENAME RECORD FILLER PIC X(4) PART1 PIC X(3) FILLER PIC X(3) PART2 PIC X(5). : Cソースプログラム 例 : #include "f6agfcfa.h" struct fa_keydesc keydesc1; keydesc1.k_flags = FA_DUPS; keydesc1.k_nparts = 2; /* number of key parts: 2 */ keydesc1.k_part[0].kp_start = 4; /* part_1: 5 1 == 4 */ keydesc1.k_part[0].kp_leng = 3; keydesc1.k_part[0].kp_flags = FA_ANYKPCODE; keydesc1.k_part[1].kp_start = 10; /* part_2: 11 1 == 10 */ keydesc1.k_part[1].kp_leng = 5; keydesc1.k_part[1].kp_flags = FA_ANYKPCODE; 59

66 第 3 章 API 関 数 と 構 造 体 b. 具 体 的 な 設 定 例 主 レコードキーは 重 複 を 許 可 しない キーパートは3つ 1 番 目 のキーパートは 先 頭 から1バイト 目 にあり 長 さは3 2 番 目 のキーパートは 先 頭 から9バイト 目 にあり 長 さは2 3 番 目 のキーパートは 先 頭 から5バイト 目 にあり 長 さは4 バイト 目 変 位 ============================================================ 番 目 のパート 3 番 目 のパート 2 番 目 のパート part1 part3 part2 COBOLで 記 述 した 場 合 の 参 考 例 : : ENVIRONMENT DIVISION CONFIGURATION SECTION INPUTOUTPUT SECTION FILECONTROL SELECT FILENAME1 ASSIGN TO SYS ORGANIZATION IS INDEXED RECORD KEY IS PART1 PART2 PART DATA DIVISION FILE SECTION FD FILENAME RECORD PART1 PIC X(3) FILLER PIC X(1) PART3 PIC X(4) PART2 PIC X(2). : 60