$ZF

function_name

引用符で囲まれた呼び出す関数の名前、または負の数。

args

args パラメータの形式は、arg1, arg2, arg3, ...argn です。この引数は、引数が渡される方法の説明、および呼び出している C 関数へのエントリ・ポイントなどの項目から構成されます。

$ZF を使用して UNIX® システム・サービスを呼び出す

Caché は、$ZF からの UNIX® システム呼び出しを使用するための、エラー・チェック機能をサポートしています。これらの呼び出しにより、非同期のイベントの確認や $ZF でのアラーム・ハンドラの設定ができます。これらの UNIX® 機能を使用することにより、実際のエラー、<CTRL-C> の割り込み、および再起動が必要な呼び出しをそれぞれ区別できます。

関数宣言は、cdzf.h に含まれており、以下のテーブルに示されているとおりです。

デバイスを制御する通常の $ZF 関数は、以下のように記述します。

  IF ((fd = open(DEV_NAME, DEV_MODE)) < 0) {
     ; Set some flags
     ; Call zferror
     ; return 0;
  }

プロセスがシグナルを受け取ると、open システム呼び出しは失敗する可能性があります。通常、これはエラーではないため、処理を再開できます。しかし、シグナルによっては他の処理が必要な場合もあります。すべての可能性を考慮して、以下の C コードを記述してください。

sigrtclr();
   WHILE (TRUE) {
      IF (sigrtchk() == 1) { return 1 or 0; }
      IF ((fd = open(DEV_NAME, DEV_MODE)) < 0) {
         switch (sigrtchk()) {
         case -1:
           /* This is probably a real device error */
           ; Set some flags
           Call zferror
           return 0;
         case 0:
           /* A innocuous signal was received. Restart. */
           ; continue;
         case 1:
           /* Someone is trying to terminate your job. */
           Do cleanup work
           return 1 or 0;
         }
      }
      ELSE { break; }
   /* Code to handle the normal situation: */
   /* open() system call succeeded         */

dzfalarm() 経由以外でシグナル・ハンドラを設定しないでください。

エンコード・システム間で文字列を変換する

Caché は、$ZF 引数タイプ、t (または T) 経由の入出力変換をサポートします。これは、以下の形式で指定します。

$ZF は、以下の C 構造にあるバイト文字列経由で、変換された文字列を外部プロシージャに移します。

typedef struct zarray {
  unsigned short len;
  unsigned char data[1]; /* 1 is a dummy value */
  } *ZARRAYP;

これは、b (または B) 引数タイプに使用された構造でもあります。

以下の $ZF サンプル関数は、可逆変換を実行します。

#include cdzf.h
extern    int trantest();
ZFBEGIN
ZFENTRY("TRANTEST","t/SJIS/ T/SJIS/",trantest)

ZFEND

int trantest(inbuf,outbuf);

ZARRAYP inbuf;         /* Buffer containing string that was converted from 
        internal Caché encoding to SJIS encoding before it
        was passed to this function */
ZARRAYP outbuf;        /* Buffer containing string in SJIS encoding that will
        be converted back to internal Caché encoding before
        it is passed back into the Caché environment */
{
  int  i;
  /* Copy data one byte at a time from the input argument buffer 
     to the output argument buffer */

  for (i = 0; i < inbuf->len; i++)
     outbuf->data[i] = inbuf->data[i];

  /* Set number of bytes of data in the output argument buffer */
       outbuf->len = inbuf->len;

  return 0;  /* Return success */
}

入出力変換の出力要素が未定義で、アプリケーションがその入出力変換を使用して NULL 文字列以外のデータを渡そうとする場合、データの変換方法が不明であるため、Caché はエラーを返します。

入出力変換の入力要素が未定義で、タイプ文字列の引数が入出力変換を $ZF 出力引数に関連付ける場合、未定義の変換を使用する出力引数は無意味なので、Caché はエラーを返します。

ゼロで終了する Unicode 文字列、および Unicode 計算文字列

$ZF 関数は、ゼロで終了する Unicode 文字列、および Unicode 計算文字列の引数タイプをサポートします。これらは、内部的に Unicode 文字を使用しない Caché のバージョンでもサポートされています。

ゼロ で終了する Unicode 文字列、および Unicode 計算文字列の引数タイプは、以下のコードを持ちます。

両方の引数タイプで、Unicode 文字の C データ型は unsigned short です。ゼロで終了する Unicode 文字列のポインタは、以下のように宣言されます。

unsigned short *p;

Unicode 計算文字列に対するポインタは、以下の C 構造に対するポインタとして宣言されます。

typedef struct zwarray {
  unsigned short len;
  unsigned short data[1]; /* 1 is a dummy value */
  } *ZWARRAYP;

例えば以下のようになります。

ZWARRAYP *p;

len フィールドには、Unicode 文字配列の長さが格納されます。

data フィールドには、Unicode 計算文字列の文字が格納されます。Unicode 文字列の最大値は、$ZF 文字列の最大値です。これは、更新できる構成パラメータで、既定は 32767 です。

各 Unicode 文字の長さは 2 バイトです。Caché は返される可能性のある最大長文字列のスペースを予約するため、出力引数として Unicode 文字列を宣言する際は、この文字の長さを考慮することが重要です。既定の文字列サイズを使用する場合、1 つの Unicode 文字列引数で使用するメモリの合計は以下のように計算します。

32767 (最大文字数) * 2 (1 文字あたりのバイト数) = 65534 (合計バイト)

この値は、すべての $ZF 引数に割り当てられる既定の最大メモリ領域の値 (67584) とほぼ同じ値です。この最大 $ZF ヒープ領域は、更新可能な構成パラメータでもあります。

エラー・メッセージ

$ZF ヒープ領域がすべて使用されている場合、$ZF は <OUT OF $ZF HEAP SPACE> エラーを発行します。$ZF 文字列スタックがすべて使用されている場合、$ZF は <STRINGSTACK> エラーを発行します。$ZF がバディブロックを割り当てることができない場合、<STORE> エラーを発行します。

子プロセスと DLL からの実行

$ZF 関数は、最初のパラメータとして負の数をとることができます。+これらの負の数は、生成された子プロセス、およびダイナミック・リンク・ライブラリ (DLL) をサポートする関数を指定します。これらの各 $ZF 関数については、別途リファレンスのページで説明されています。