$VIEW

offset

この引数の値は、mode 引数の値に応じて指定します。以下は、その説明です。

• mode が 0、-1、または -2 のときは、ベース・アドレスからのオフセットとして、0 から始まる正の整数をバイト単位で指定します。

• mode が -3 または正の整数のときは、プロセスのアドレス空間内のアドレスを指定します。値 -1 を使用すると、下記の “プロセスの要約情報” の説明に従って、プロセス状態の要約を取得できます。

• mode が -5 のときは、現行ブロック内のグローバル・ノード数を指定する正の整数を指定します。この場合、奇数値はグローバル参照全体を返し、偶数値はポインタまたはデータを返します。

mode

mode で利用可能な値は、以下のとおりです。mode が省略されたときの既定値は -1 です。値の中には実装固有なものもあります。実装制限は以下の表に示します。

length

長さ (バイト単位)、またはフラグ文字。解釈は mode および offset の値によって決定します。

• mode が 0、-1、または -2、-3、 または正の整数 (pid) で、offset が正の整数の場合は、length パラメータは以下のようになります。

  • データの長さを文字列で返す、-1 ～ 最大長の負の整数。$VIEW は、offset によって示されるアドレスで始まる、指定した文字数を返します。

  • 1 ～ 8 の正の整数は、データの小数値を返します。$VIEW は、1 ～ 4 の連続したバイトか、offset によって示されるアドレスで始まる連続した 8 バイトを返します。

  • 引用符で囲んだ文字列の 文字 C または P は、32 ビット・システム上の 4 バイト・アドレス、または 64 ビット・システム上の 8 バイト・アドレスを示します。C または P を指定する場合は、整数値の length は指定しません。

  逆順でバイト値を返す (下位バイトを最下位アドレスに置く) には、文字 O を length 値に追加し、結果の文字列を二重引用符で囲みます。

  length パラメータが省略された場合、既定値は 1 です。

• mode が -3 または正の整数 (pid) で offset が -1のときは、length パラメータは要約情報の形式を指定するフラグです。length に 1 を指定すると、この要約を区切り文字で返し、2 を指定するとこの要約を $LIST 構造として返します。length パラメータが省略された場合、既定値は 1 です。

• mode が -5 のときは、length パラメータは指定しないでください。

VIEW の使用の制限

$VIEW 関数は、制限付きのシステム機能です。呼び出されるコードが CACHESYS データベース内にあるので、コマンドは保護されます。詳細は、"Caché セキュリティ管理ガイド" の "アセットおよびリソース" の章にある “特別な機能” を参照してください。

プロセス要約情報

offset が -1 の場合、以下の例に示すように mode -3 を使用して、現在のプロセスのアドレス空間から要約情報を ^ 区切り文字として返すことができます。

  WRITE $VIEW(-1,-3,1)

以下のように同じ情報を $LIST 構造として返すことができます。

  SET infolist = $VIEW(-1,-3,2)
  ZWRITE infolist

指定されたプロセスのアドレス空間から要約情報を返すには、以下の例に示すようにそのプロセスのプロセス ID (pid) を mode 引数の正の整数として指定します。

  SET pid=$PIECE($IO,"|",4)
  WRITE $VIEW(-1,pid,1)

要約情報の返り値は、以下の形式で返されます。

pid^mode^dev^mem^dir^rou^stat^prio^uic^loc^blk^^^defns^lic^jbstat^mempeak

モード -5 の使用法

表示バッファの現在のブロックにグローバルの一部が含まれている場合、mode に -5 を指定すると、グローバル参照とブロックに含まれている値が返されます。length パラメータは、mode -5 には有効ではありません。

-5 の mode を使用した場合、offset 値は、ベース・アドレスのバイト・オフセットではなく、ブロックにあるグローバル・ノードを指定します。奇数値は、グローバル参照全体を返し、偶数値はポインタあるいはデータを返します。

例えば、表示バッファの n 番目のノードのグローバル参照全体を返すには、offset に n*2-1 を指定します。n 番目のノードの値を返すには、n *2 を指定します。ブロックの最終ノードのグローバル参照を返すには、offset に -1 を指定します。

$VIEW は、照合順 (つまり数値) でノードを返します。これは $ORDER 関数が使用するものと同じ順序です。この順序を想定したコードを記述することにより、表示バッファでグローバルを使用してすばやく順次スキャンを実行できるようになります (Caché ユーティリティの一部は、この方法を使用します)。$VIEW は、offset が表示バッファの最後のノードを過ぎて位置を指定するとき、NULL 文字列 ("") を返します。コードの中にこの値についてのテストを含むようにしてください。

現在のブロックがポインタ・ブロックのときは、返り値はポインタである Caché ブロック数です。ブロックがデータ・ブロックのときは、返り値はノードに対応したデータ値です。

$VIEW が <DATABASE> エラーもしくは <FUNCTION> エラーを出した場合は、ブロックでの情報は有効なグローバル参照でも有効なデータでもないという意味になります。

以下の例は、表示バッファのコンテンツを検査するための、汎用コードを示しています。コードは最初に表示バッファを開いてから、読み取るためのブロック数を入力できるようにします。FOR ループは、現在のブロックすべてのオフセットを繰り返します。$VIEW 関数は、-5 のモードを使用して、各オフセットで値を返します。WRITE コマンドは、結果の 1 組みのオフセット値を出力します。

ブロックの最後まで行くと、$VIEW は NULL 文字列 ("") を返します。IF コマンドは、この値をテストをして、“End of block” メッセージを書き込みます。その後、QUIT コマンドは、ループを終了して制御をプロンプトに戻し、ユーザが他のブロックで読み取りできるようにします。

Start OPEN 63
      WRITE !,"Opening view buffer."
      READ !!,"Number of block to read in: ",block QUIT:block=""
      VIEW block
         FOR i=1:1 { 
               SET x=$VIEW(i,-5)
               IF x="",i#2 {
                    WRITE !!,"End of block: ",block
                    CLOSE 63
                    QUIT }
               WRITE !,"Offset = ",i
               WRITE !,"Value = ",x
        }
        GOTO Start+2
        CLOSE 63
        QUIT

グローバル・ブロックについて、通常このルーチンによって作成される出力は、以下のとおりです。

Opening view buffer.
Number of block to read in:3720
Offset = 1
Value = ^client(5)
Offset = 2
Value = John Jones
Offset = 3
Value = ^client(5,1)
Offset = 4
Value = 23 Bay Rd./Boston/MA 02049
 .
 .
 .
Offset = 126
Value = ^client(18,1,1)
Offset = 127
Value = Checking/45673/1248.00
End of block: 3720
Number of block to read in:

逆の順序のバイト値 (ビッグ・エンディアンのみ)

ビッグ・エンディアン・システムでは、length パラメータの一部として文字 “O” 接尾語を使用することにより、逆順序でバイト値を返すことができます。length に文字 O を含めて指定すると、$VIEW は逆順序でバイト値を返します (length は二重引用符で囲まなければなりません)。詳細は、以下の例を参照してください。

   USE IO 
   FOR Z=0:0 {
      WRITE *-6 
      SET NEXTBN=$VIEW(LINKA,0,"3O") 
      QUIT:NEXTBN=0 }

前述の例では、$VIEW の length パラメータは "3O" です (3 と 文字 O)。ビッグ・エンディアン・システムで実行される場合、これは、逆の順序 (O) の次の 3 バイト (3) の長さを示しています。そのため、$VIEW はメモリにある位置 (表示バッファ　—　0 の mode で示されるように) で開始し、最上位バイト、2 番目の上位バイト、および 3 番目の上位バイトを返します。

リトル・エンディアン・システムでは、文字 “O” は空命令です。“3O” の length 値は、“3” の length 値と同じです。

IsBigEndian()Opens in a new tab クラス・メソッドを使用して、オペレーティング･システム・プラットフォームでどのビット順序を使用するかを決定できます (1 = ビッグ・エンディアン・ビット順、0 = リトル・エンディアン・ビット順)。

  WRITE $SYSTEM.Version.IsBigEndian()