第 7 章 ファイルハンドラとソートのAPI

7.1 ファイルハンドラの呼び出し

7.1.1 概要

次の構文を使用すると、プログラムでファイルハンドラを明示的に呼び出すことができます。

call "EXTFH" using opcode fcd

各パラメータの内容は次のとおりです。

最初の呼び出しの前に、次の手順を行う必要があります。

1. ファイル制御記述 (FCD)、レコード領域、ファイル名領域、キー定義ブロック (索引ファイルの場合) にデータ領域を割り当てます。
   
   
2. ファイルハンドラが無効な値を受け取らないように、すべてのデータ領域をバイナリのゼロに初期化します。
   
   
3. FCD に次の領域へのポインタを設定します。
   
   
   • レコード領域
     
     
   • ファイル名領域
     
     
   • キー定義ブロック (索引ファイルの場合のみ)

その後で、各ファイルハンドラ操作に対して次の手順を行います。

1. 選択したオペレーションコードに対応する FCD のフィールドに入力を行います。
   
   
2. ファイルハンドラを呼び出します。
   
   
3. ファイル状態を確認して、ファイルの入出力操作が正常に行われたかどうかを判断します。
   
   
4. FCD フィールドやレコード領域のデータを処理します。

7.1.2 データ構造体

ファイルハンドラでは、ファイルの入出力操作中に次の 4 つのデータ構造体を使用します。

• ファイル制御記述

  FCD は 使用中のファイルに関する情報が記述されているデータ領域です。

• レコード領域

  レコード領域は、レコードの読み取りや書き出しを行うデータ領域です。

• ファイル名領域

  ファイル名領域は、使用中のファイルの名前を記述するデータ領域で、オペレーティングシステムにより認識されます。

• キー定義ブロック

  キー定義ブロックには、ファイルハンドラが索引ファイルの操作中に索引キー情報を記述します。

7.1.2.1 ファイル制御記述 (FCD)

ファイルハンドラを使用するには、プログラムで FCD をセットアップし、該当するフィールド (オペレーションコードによってフィールドが異なります) への入力とファイルハンドラの呼び出しを行います。FCD の該当フィールドに入力を行うと、ファイルハンドラがプログラムに情報を返します。

FCD で未使用の領域や予約済みの領域は、バイナリのゼロに設定する必要があります。

ファイルオープン呼び出しに使用した FCD はその後、このファイルに対してアクセスするときに必ず使用する必要があります。1 つのファイルに対して複数のオープン操作を実行できますが、各オープン操作ごとに別の FCD を使用する必要があります。

FCD には、レコード領域、ファイル名領域、キー定義ブロックへのポインタ (USAGE POINTER データ項目) を記述します。

WRITE AFTER ADVANCING line-count LINES

7.1.2.2 レコード領域

レコード領域は、レコードの読み取りと書き出しを行うデータ領域です。

レコード領域のサイズは、ファイルの最大レコードよりも 4 バイト大きい必要があります。

次の例は、FCD にレコード領域へのポインタを設定する方法を示しています。

01 RECORD-AREA      PIC X(85).
...
   SET FCD-RECORD-ADDRESS TO ADDRESS OF RECORD-AREA
   ...

7.1.2.3 ファイル名領域

ファイル名領域は、使用中のファイルの名前を記述するデータ領域で、オペレーティングシステムにより認識されます。

ドライブやパスの情報だけではなく、ファイルの実際の名前も記述することができます。名前の最後は空白文字でなければなりません。

このファイル名領域は、ファイルに対する最初の操作より前に記述する必要があります。

次の例は、FCD でファイル名領域へのポインタを設定する方法を示します。

01 FILENAME-AREA    PIC X(65) VALUE "master.dat".
...
   MOVE 65 TO FCD-NAME-LENGTH
   SET FCD-FILENAME-ADDRESS TO ADDRESS OF FILENAME-AREA
   ...

7.1.2.4 キー定義ブロック

キー定義ブロックは、索引ファイルを開くときに、ファイルハンドラに索引キー情報を渡すために使用します。キー定義ブロックは、次に示す 3 つのデータ領域で構成されます。

• グローバル情報領域
  
  
• キー定義領域
  
  
• 構成要素定義領域

7.1.2.4.1 グローバル情報領域

グローバル情報領域には、キー定義領域のサイズとファイルに含むキーの数を記述します。

未使用の領域や予約済みの領域はバイナリのゼロに初期化する必要があります。

7.1.2.4.2 キー定義領域

キー定義領域には、索引ファイルで使用するキーを記述します。

キー定義領域は、グローバル情報領域の次に配置され、ファイルにある各キーにつきキー定義を 1 つ記述します。

すべてのキーは、構成要素より前に定義する必要があります。

キー位置の順序に基づいてキーを識別するため、キーを定義する順序は重要です。例えば、主キーと 2 つの副キーを持つ索引ファイルがある場合は、キー定義領域に 3 つのキー定義を記述します。この場合、主キーをキー 0、最初の副キーをキー 1、2 番目の副キーをキー 2 とします。

次に、キー定義領域のレイアウトを示します。未使用の領域や予約済みの領域はすべてバイナリゼロに初期化する必要があります。

7.1.2.4.3 構成要素定義領域

構成要素定義領域は、キー定義領域の後にあります。

この領域では、各キーの構成要素を定義します。分割キー以外の各キーは、1 つの構成要素から成り立ち、各構成要素をそれぞれ定義する必要があります。

構成要素の定義では、キー構成要素の位置と長さを指定します。

数字キーの場合は、構成要素定義領域を使用して、数値の型を指定することができます。その後で、IXNUMKEY コンパイラ指令を使用すると、数値の型にしたがってキーを順序付けることができます (デフォルトでは、キーが英数字順に並びます)。

構成要素定義領域のレイアウトを次に示します。未使用の領域や予約済みの領域はバイナリゼロに初期化する必要があります。

7.1.3 FCD へのアクセス

プログラムで通常の COBOL 構文を使用してファイルの入出力操作を行う場合、各ファイルに対してファイル制御記述 (FCD) が自動的に作成されます。この自動的に作成された FCD にアクセスするには、FCDREG コンパイラ指令でプログラムをコンパイルします。これにより、FCD の読み取りや変更、FCD を使用したファイルハンドラの明示的な呼び出しなどが可能になります。

FCD にアクセスするには、プログラムの連絡節に FCD 定義を設定する必要があります。FCD 定義の例は、ファイル XFHFCD.CPY (Infomgr を使用して検索できます) に保存されています。プログラムで次の SET 文を使用すると、読み取りや変更を行う FCD にこの定義をマップすることができます。

set address of fcd to address of fh--fcd of file

各パラメータの内容は次のとおりです。

この SET 操作に続けて、連絡部で設定した FCD のデータ項目にアクセスすると、ファイルの FCD へアクセスすることができます。

同様に、次のように指定すると、キー定義ブロックにアクセスすることができます。

set address of kdb to address of fh--keydef of file

次に、FCD へのアクセス例を示します。

FCD へのアクセス例

次のプログラムでは、ファイルのキー定義ブロックで適切なビットを設定して、ファイルのキー圧縮を有効化します。

$set fcdreg
     select masterfile 
         assign to ... 
         organization is indexed 
         record key is rec-key 
         alternate key is m-alt-key-1 with duplicates 
         alternate key is m-alt-key-2 
         alternate key is m-alt-key-3 with duplicates. 
     select indexfile 
         assign to ... 
         organization is indexed 
         record key is rec-key 
         alternate key is t-alt-key-1 with duplicates. 
   ... 
 working-storage section. 
   ... 
 linkage section. 
 01 key-def-block. 
    03 filler pic x(6). 
    03 key-count pic 9(4) comp-x. 
    03 filler pic x(6). 
    03 key-def occurs 1 to 4 times depending on key-count. 
       05 filler pic x(5). 
       05 key-compression pic 9(2) comp-x. 
       05 filler pic x(10). 
  ... 
 procedure division. 
     set address of key-def-block 
                      to address of fh--keydef of masterfile
     move 6 to key-compression (1) 
     move 7 to key-compression (2) 
     move 6 to key-compression (3) 
     move 7 to key-compression (4) 
     open I-O masterfile 
  ... 
     set address of key-def-block 
                       to address of fh--keydef of indexfile
     move 4 to key-compression (1) 
     move 1 to key-compression (2) 
     open input indexfile

7.1.4 オペレーションコード

ファイルハンドラが実行するファイル操作は、2 バイトのオペレーションコードで識別します。

オペレーションコードには、標準と特殊の 2 種類があります。

• 標準オペレーションコード

  標準オペレーションコードでは、MSB に x"FA" が格納されます。LSB は、特定の操作を示します。

• 特殊オペレーションコード

  特殊オペレーションコードでは、MSB に x"00" が格納されます。LSB は、特定の操作を示します。

7.1.4.1 標準オペレーションコード

標準オペレーションコードでは、MSBに x"FA" が格納されます。LSB は、特定の操作を示します。

• Close - ファイルの処理を終了します。
  
  
• Commit - 実行ユニットによって保持されているすべてのファイルのレコードロックをすべて解除します。
  
  
• Delete - レコードをファイルから論理的に削除します。
  
  
• Delete file - 指定されたファイルを、そのファイルが常駐している物理デバイスから物理的に削除します。
  
  
• Open - ファイルの処理を開始します。また、ラベルのチェックまたは書込み (およびその両方) およびその他の入出力操作も実行します。
  
  
• Read - 順アクセスの場合は、READ によりファイルから次または前の論理レコードを利用できます。ランダムアクセスの場合は、READ によりディスクファイルから指定したレコードを利用できます。
  
  
• Rollback - 実行ユニットで保持されているすべてのファイルのレコードロックをすべて解除します。
  
  
• Start - レコードの順検索について、相対ファイルまたは索引ファイルの論理位置決めに対する基礎を提供します。
  
  
• Step - 次の物理レコードへ進みます。
  
  
• Unlock - 指定したファイルに対し実行ユニットで保持されているすべてのレコードロックを解除します。
  
  
• Write または rewrite - 出力または入出力ファイルの論理レコードを解放します。

オペレーションコードの中には、特定のファイル編成でのみ有効なものがあります。各オペレーションコードの説明では、次のキーを使用して、対応するファイル編成のリストを示します。

L    行順
S    レコード順 (vS を含む)
R    相対 (vR を含む)
I    索引

vS    可変形式の順のみ

vR    可変形式の相対のみ

Close

必要に応じてオプションのリワインドおよびロックを使用し、ファイルおよびリールまたはユニットの処理を終了します。レコード順ファイルの場合は、「リール」および「ユニット」という用語を同じ意味で使用します。順ディスクファイルは、テープまたは似たような順メディアのファイルと同等に扱われます。

入力フィールド

なし

出力フィールド

Commit

実行ユニットによって保持されているすべてのファイルのレコードロックをすべて解除します。

入力フィールド

ファイルが使用する FCD が常に必要です。

出力フィールド

なし

Delete

レコードをディスクファイルから論理的に削除します。このコードは、相対または索引編成のファイルに対してのみ指定できます。

入力フィールド

出力フィールド

Delete File

指定されたファイルを、そのファイルが常駐している物理デバイスから物理的に削除します。

入力フィールド

ファイル名領域

出力フィールド

Open

ファイルの処理を開始します。また、ラベルのチェックまたは書込み (およびその両方) およびその他の入出力操作も実行します。

入力フィールド

ファイル名領域

キー定義ブロック (I)

出力フィールド

ファイルの複数回オープン

同じ物理ファイルにいくつかの FCD を割り当てて、それらのファイルを同時に開くことができます。オペレーティングシステムでは、これを 1 つの開かれたファイルとしてカウントします。物理ファイルは、その物理ファイルに割り当てたすべての論理ファイルが閉じてから、閉じます。

Read

順アクセスの場合は、READ によりファイルから次または前の論理レコードを利用できます。ランダムアクセスの場合は、READ によりディスクファイルから指定したレコードを利用できます。

入力フィールド

出力フィールド

Rollback

実行ユニットで保持されているすべてのファイルのレコードロックをすべて解除します。

入力フィールド

なし

出力フィールド

なし

Start

レコードの順検索について、相対ファイルまたは索引ファイルの論理位置決めに対する基礎を提供します。

入力フィールド

出力フィールド

Step

次の物理レコードへ進みます。この操作によって、レコードへのアクセスが大幅に高速化されます。

入力フィールド

出力フィールド

コメント

STEP 操作は、相対ファイルまたは索引ファイルのレコードを順番に検索するための方法です。この操作では、キーまたは相対レコード番号を使用して読み取る必要はありません。通常、この方法を使用するとファイル内のデータへのアクセスが高速化されます。

STEP NEXT 操作によって、 (STEP または READ 操作により) ファイルで最後に検索されたレコードの次に物理的に格納されるレコードが返されます。

相対バイトアドレス指定を使用し、アクセスしたばかりのレコードに対して現在のレコードポインタが更新されるように指定している場合は、STEP 操作がこの新しい位置に対して実行されます。

相対バイトアドレスは、すべての STEP 操作で返されます。そのため、検索したばかりのレコードに対する現在のレコードポインタを更新する必要がある場合は、返されたアドレスを使用して READ (直接) 操作を実行します。

注： 現在のレコードポインタは、STEP 操作に影響されません。

Unlock

指定したファイルに対し実行ユニットで保持されているすべてのレコードロックを解除します。

入力フィールド

なし

出力フィールド

Write

新しいレコードをファイルへ書き込みます。

順ファイルの場合は、論理ページの垂直行の位置決めにも使用できます。

REWRITE 操作は既存のレコードを置き換えます。

入力フィールド

出力フィールド

7.1.4.2 特殊オペレーションコード

特殊オペレーション コードでは、MSB に x"00" が格納されます。LSB は、特殊操作を示します。

• File Information - すべてのファイル編成について一般的なファイル情報を返し、索引ファイルについてファイルキーに関する情報をキー定義ブロックの形式で返します。
  
  
• Create Index File - ファイルに新しい索引を追加するためのヘッダー情報のみを含む新しい .idx ファイルを作成します。
  
  
• Get Next Record - 索引ファイルのデータファイル部分から次の物理レコードを取得します。
  
  
• Add Key Value - 索引ファイルの索引ファイル部分にキー値を追加します。
  
  
• Re-index File - 提供されたキー定義ブロックを使用してファイルの索引を再作成します。
  
  
• Flush File - 特定のファイルのすべてのデータをディスクに書き出します。
  
  
• Unlock Record - ファイル内の特定のレコードをロック解除します。
  
  

CALLFH"USERFH"

cob -x -msqfile=myseqfh myapp.cbl myseqfh.o

 78 close-file                  value x"fa80"
 78 open-new-index              value x"0007".
 78 get-next-rec                value x"0008".
 78 add-key-value               value x"0009".
 ...
     move open-new-index to fh-opcode
     perform extfh-op
     move get-next-rec to fh-opcode
     perform extfh-op
     perform until fcd-status (1:1) not = "0"
         perform varying fcd-key-id from 0 by 1
                   until fcd-key-id = key-count 
                      or fcd-status (1:1) not = "0"  
             move add-key-value to fh-opcode
             perform extfh-op
         end-perform
         move get-next-rec to fh-opcode
         perform extfh-op
     end-perform
     move close-file to fh-opcode
     perform extfh-op
     ...
 extfh-op.
     call "EXTFH" using fh-opcode, fcd
     if fcd-status of fcd (1:1) = "1"
         move 1 to return-code
     end-if.

        call "CBLDCnnn" using input-buffer,
			      input-buffer-size,
			      output-buffer,
			      output-buffer-size,
			      compression-type

call "EXTSM" using function-code, sort-fcd