Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

コールイン関数リファレンス

このリファレンスの章では、すべての Caché コールイン関数をアルファベット順に挙げて、詳しく説明します。機能別のコールイン関数の概要については、"コールイン関数の使用法" を参照してください。

Note:

文字列を操作する Caché コールイン関数には、8 ビット・バージョンと Unicode バージョンの両方があります。これらの関数は、処理する文字列のタイプを示すために接尾語を使用します。

  • 接尾語 “A” の付いた名前、またはまったく接尾語の付かない名前 (例えば、CacheEvalA または CachePopStr など) は、8 ビット文字列のバージョンです。

  • 接尾語 W の付いた名前 (例えば、CacheEvalW または CachePopStrW など) は、2 バイトの Unicode 文字を使用するプラットフォーム上の Unicode 文字列用のバージョンです。

  • 接尾語 H の付いた名前 (例えば、CacheEvalH または CachePopStrH など) は、4 バイトの Unicode 文字を使用するプラットフォーム上の Unicode 文字列用のバージョンです。

いくつかのバージョンがある関数であっても、ここではわかりやすいように各関数の説明でまとめて扱っています。例えば、CacheEvalA[W][H]、CachePopStr[W][H] のように記載しています。

アルファベット順の関数リスト

ここでは、すべてのコールイン関数をアルファベット順に挙げ、各関数の簡単な説明と詳細な説明へのリンクを示します。

  • CacheAbort — 必要に応じて、Caché 側で処理中の現在の要求をキャンセルするように Caché に命令します。

  • CacheAcquireLock — Cache LOCK コマンドを実行します。CachePushLockX[W][H] を使用してロック参照を設定しておく必要があります。

  • CacheChangePasswordA[W][H] — Caché 認証が使用されている場合に、ユーザのパスワードを変更します (他の形式の認証では無効)。

  • CacheBitFind[B] — ビット文字列内の指定されたビット値の位置を返します (Caché $BITFIND に類似)。

  • CacheCloseOref — OREF に対するシステム参照カウンタをデクリメントします。

  • CacheContext — 外部コールイン・プログラムを使用しているときに、接続の Caché 側で現在処理中の要求がある場合、True を返します。

  • CacheConvertCacheEvalA[W][H] で返された値を適切な形式に変換し、その返り値で指定されたアドレスに置きます。

  • CacheCtrl — Caché が CTRL-C を無視するかどうかを決定します。

  • CacheCvtExStrInA[W][H] — 指定の外部文字セット・エンコーディングを持つ文字列を、Caché の 8 ビット・バージョンで内部的にのみ使用されるローカルの 8 ビット文字列エンコーディングに変換します。

  • CacheCvtExStrOutA[W][H] — Caché の 8 ビット製品で内部的に使用されるローカルの 8 ビット文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の 8 ビット・バージョンでのみ使用可能です)。

  • CacheCvtInA[W][H] — 指定の外部文字セット・エンコーディングを使用した文字列を、ローカルの 8 ビット文字列エンコーディング (Caché の 8 ビット・バージョンで内部的にのみ使用する場合) または Unicode 文字列エンコーディング (Caché の Unicode バージョンで内部的にのみ使用する場合) に変換します。

  • CacheCvtOutA[W][H] — Caché の 8 ビット製品で内部的に使用されるローカルの 8 ビット文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の 8 ビット・バージョンでのみ使用可能です)。

  • CacheDoFun — ルーチン呼び出しを実行します (特殊な場合)。

  • CacheDoRtn — ルーチン呼び出しを実行します。

  • CacheEnd — Caché プロセスを終了します。切断された接続が存在する場合は、削除操作も行います。

  • CacheEndAll — すべてのコールイン・スレッドを切断し、そのスレッドが終了するまで待機します。

  • CacheErrorA[W][H] — 最新のエラー・メッセージ、関連するソース文字列、ソース文字列内でのエラーの発生箇所のオフセットを返します。

  • CacheErrxlateA[W][H] — 整数のエラー・コードを Cache エラー文字列に変換します。

  • CacheEvalA[W][H] — 文字列を、それが Caché の式であるかのように評価し、返り値をメモリに格納して、CacheTypeCacheConvert による処理がさらに進められるようにします。

  • CacheExecuteA[W][H] — Caché のプログラマ・プロンプトで入力されたかのように、コマンド文字列を実行します。

  • CacheExStrKill — EXSTR 文字列に関連付けられているストレージを解放します。

  • CacheExStrNew[W][H] — 文字列に対して要求されたストレージの容量を割り当て、EXSTR 構造に、構造の長さおよび構造の値フィールドへのポインタを埋め込みます。

  • CacheExtFun — 返り値を引数スタックにプッシュする外部関数呼び出しを実行します。

  • CacheGetPropertyCachePushProperty[W][H] により定義されたプロパティの値を取得します。この値は、引数スタックにプッシュされます。

  • CacheGlobalData — 指定したグローバルに対して $Data を実行します。

  • CacheGlobalGetCachePushGlobal[W][H] および任意の添え字により定義されたグローバル参照の値を取得します。このノード値は、引数スタックにプッシュされます。

  • CacheGlobalIncrement$INCREMENT を実行し、スタックの一番上の結果を返します。

  • CacheGlobalKill — グローバル・ノードまたはツリーに対して ZKILL を実行します。

  • CacheGlobalOrder — 指定したグローバルに対して $Order を実行します。

  • CacheGlobalQuery — 指定したグローバルに対して $Query を実行します。

  • CacheGlobalRelease — 保持されたグローバル・バッファの所有権 (存在する場合) を解放します。

  • CacheGlobalSetCachePushGlobal[W][H] および任意の添え字により定義されたグローバル参照の値を格納します。この呼び出しを行う前に、ノード値を引数スタックにプッシュしておく必要があります。

  • CacheIncrementCountOref — OREF に対するシステム参照カウンタをインクリメントします。

  • CacheInvokeClassMethodCachePushClassMethod[W][H] および任意の引数によって定義されたクラス・メソッド呼び出しを実行します。返り値は、引数スタックにプッシュされます。

  • CacheInvokeMethodCachePushMethod[W][H]、および引数スタックにプッシュされた任意の引数によって定義されるインスタンス・メソッド呼び出しを実行します。

  • CacheOflush — 保留中の出力をすべてフラッシュします。

  • CachePop — 引数スタックから値をポップ・オフします。

  • CachePopCvtW[H] — 引数スタックからローカルの 8 ビット文字列をポップ・オフし、Unicode に変換します。Unicode バージョンの CachePopStr[W][H] と同じです。

  • CachePopDbl — 引数スタックから値をポップ・オフし、double 型に変換します。

  • CachePopExStr[W][H] — 引数スタックから値をポップ・オフし、長い文字列に変換します。

  • CachePopExStrCvtW[H] — 引数スタックから値をポップ・オフし、長い Unicode 文字列に変換します。

  • CachePopInt — 引数スタックから値をポップ・オフし、integer 型に変換します。

  • CachePopInt64 — 引数スタックから値をポップ・オフし、64ビット (long long) 数値に変換します。

  • CachePopList — 引数スタックから $LIST オブジェクトをポップ・オフして変換します。オブジェクトが Unicode バージョンであるか、8 ビット・バージョンであるかに応じて、文字列要素は適宜、コピーまたは変換されます。

  • CachePopOref — 引数スタックから OREF をポップ・オフします。

  • CachePopPtr — 引数スタックから、ポインタを内部形式でポップ・オフします。

  • CachePopStr[W][H] — 引数スタックから値をポップ・オフし、string 型に変換します。

  • CachePromptA[W][H] — プログラマ・プロンプトである文字列を返します。

  • CachePushClassMethod[W][H] — クラス・メソッド参照を引数スタックにプッシュします。

  • CachePushCvtW[H] — Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。Unicode バージョンの CachePushStr[W][H] と同じです。

  • CachePushDbl — Caché の double 型を引数スタックにプッシュします。

  • CachePushExStr[W][H] — 長い文字列を引数スタックにプッシュします。

  • CachePushExStrCvtW[H] — Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。

  • CachePushFunc[W][H] — 外部関数参照を引数スタックにプッシュします。

  • CachePushFuncX[W][H] — 拡張外部関数参照を引数スタックにプッシュします。

  • CachePushGlobal[W][H] — グローバル参照を引数スタックにプッシュします。

  • CachePushGlobalX[W][H] — 拡張グローバル参照を引数スタックにプッシュします。

  • CachePushIEEEDbl — IEEE の double 型を引数スタックにプッシュします。

  • CachePushInt — integer 型を引数スタックにプッシュします。

  • CachePushInt64 — 64ビット (long long) 値を引数スタックにプッシュします。

  • CachePushList — $LIST オブジェクトを変換し、引数スタックにプッシュします。

  • CachePushLock[W][H] — ロック名を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

  • CachePushLockX[W][H] — ロック名と環境文字列を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

  • CachePushMethod[W][H] — インスタンス・メソッド参照を引数スタックにプッシュします。

  • CachePushOref — OREF を引数スタックにプッシュします。

  • CachePushProperty[W][H] — プロパティ参照を引数スタックにプッシュします。

  • CachePushPtr — ポインタを内部形式で引数スタックにプッシュします。

  • CachePushRtn[W][H] — ルーチン参照を引数スタックにプッシュします。

  • CachePushRtnX[W][H] — 拡張ルーチン参照を引数スタックにプッシュします。

  • CachePushStr[W][H] — バイト文字列を引数スタックにプッシュします。

  • CachePushExStrCvtW[H] — Unicode 文字列をローカルの 8 ビット・エンコーディングに変換し、引数スタックにプッシュします。

  • CachePushUndef — 省略された関数引数として解釈される未定義値をプッシュします。

  • CacheReleaseAllLocks — 引数なしの Cache LOCK コマンドを実行して、プロセスによって現在保持されているロックをすべて削除します。

  • CacheReleaseLock — Cache LOCK コマンドを実行して、指定したロック名のロック・カウントをデクリメントします。このコマンドは、一度に 1 つずつ増分ロックを解放するだけです。

  • CacheSecureStartA[W][H] — Cache プロセスをセットアップするために、Cache を呼び出します。

  • CacheSetDir — 実行時に、マネージャのディレクトリの名前を動的に設定します。

  • CacheSetPropertyCachePushProperty[W][H] により定義されたプロパティの値を格納します。

  • CacheSignal — ユーザ・プログラムにより補足された信号を Caché に渡します。

  • CacheSPCReceive — シングル・プロセス通信メッセージを受信します。

  • CacheSPCSend — シングル・プロセス通信メッセージを送信します。

  • CacheStartA[W][H] — Caché プロセスをセットアップするために、Caché を呼び出します。

  • CacheTCommit — Cache TCommit コマンドを実行します。

  • CacheTLevel — トランザクション処理に対する、現在の入れ子レベル ($TLEVEL) を返します。

  • CacheTRollback — Cache TRollback コマンドを実行します。

  • CacheTStart — Cache TStart コマンドを実行します。

  • CacheTypeCacheEvalA[W][H] により、関数値として返される項目のネイティブ・タイプを返します。

  • CacheUnPopCachePop からスタック・エントリをリストアします。

CacheAbort

int CacheAbort(unsigned long type)
引数

type 接続の切断方法を指定する次の事前定義値のどちらかになります。
  • CACHE_CTRLC — (CTRL-CCacheCtrl で有効になっているかどうかに関係なく) CTRL-C が処理されたかのように、Caché の処理に割り込みます。Caché への接続は維持されます。

  • CACHE_RESJOB — コールイン接続を切断します。その後、最初に CacheEnd、次に CacheStart を呼び出し、Caché に再接続する必要があります。

説明

必要に応じて、Caché 側で処理中の現在の要求をキャンセルするように Caché に命令します。この関数は、AST (非同期システム・トラップ)、またはコールイン側で実行されているスレッドで重大なイベントが検知された場合に使用します (現在、処理中の Caché 要求があるかどうかを判断するには、CacheContext を使用します)。ただし、これは AST または独立したスレッドを使用するコールイン・プログラムにのみ当てはまります。

CacheAbort の返り値

CACHE_BADARG 終了タイプは無効です。
CACHE_CONBROKEN 接続は切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_NOTINCACHE 現在コールイン・パートナーが Caché に存在しません。
CACHE_SUCCESS 接続が確立されました。

rc = CacheAbort(CACHE_CTRLC);

CacheAcquireLock

int CacheAcquireLock(int nsub, int flg, int tout, int * rval)
引数

nsub ロック参照にある添え字の数
flg ロック・コマンドの修飾語有効な値は、CACHE_INCREMENTAL_LOCK と CACHE_SHARED_LOCK のいずれか、または両方です。
tout ロック・コマンドが完了するのを待機する時間 (秒)。タイムアウトを指定しない場合、マイナスの値。0 は、ロックが利用できない場合に即座に返すという意味です。ただし、ロックがリモート・システムにマップされている場合には最小のタイムアウトが適用される場合があります。
rval 成功を 1、失敗を 0 で示す int 返り値への、オプションのポインタ。
説明

Cache LOCK コマンドを実行します。ロック参照は、CachePushLock で設定済みである必要があります。

CacheAcquireLock の返り値

CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_SUCCESS LOCK コマンドを正常に呼び出しました (ただし、rval パラメータを調べて、ロックが成功したかどうかを判断する必要があります)。
CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。

CacheBitFind

int CacheBitFind(int strlen, unsigned short *bitstr, int newlen, int srch, int revflg)
引数

strlen ビット文字列のデータ長。
bitstr Unicode ビット文字列へのポインタ。
newlen 文字列の最初から検索を開始する場合は 0 を指定し、それ以外は 1 から始まる開始位置を指定します。
srch ビット文字列内を検索するビット値 (0 または 1)。
revflg 検索の方向を指定します。

1newlen で指定された位置から順方向 (左から右) に検索します。

0newlen で指定された位置から逆方向に検索します。

説明

ビット文字列 bitstr 内の srch で指定された値を持つビットの次のビット位置 (先頭は 1) を返します。検索の方向は revflg で指定します。指定された方向に指定された値のビットがそれ以上見つからない場合は 0 が返されます。

この関数は、Caché$BITFIND に類似しています (“ビット文字列関数の概要” も参照)。

CacheBitFind の返り値

CACHE_SUCCESS 操作は正常に終了しました。

CacheBitFindB

int CacheBitFindB(int strlen, unsigned char *bitstr, int newlen, int srch, int revflg)
引数

strlen ビット文字列のデータ長。
bitstr ビット文字列へのポインタ。
newlen 文字列の最初から検索を開始する場合は 0 を指定し、それ以外は 1 から始まる開始位置を指定します。
srch ビット文字列内を検索するビット値 (0 または 1)。
revflg 検索の方向を指定します。

1newlen で指定された位置から順方向 (左から右) に検索します。

0newlen で指定された位置から逆方向に検索します。

説明

ビット文字列 bitstr 内の srch で指定された値を持つビットの次のビット位置 (先頭は 1) を返します。検索の方向は revflg で指定します。指定された方向に指定された値のビットがそれ以上見つからない場合は 0 が返されます。

この関数は、Caché$BITFIND に類似しています (“ビット文字列関数の概要” も参照)。

CacheBitFindB の返り値

CACHE_SUCCESS 操作は正常に終了しました。

CacheChangePasswordA

バリアント : CacheChangePasswordWCacheChangePasswordH

int CacheChangePasswordA(CACHE_ASTRP username, CACHE_ASTRP oldpassword, CACHE_ASTRP newpassword)
引数

username 変更が必要なパスワードを使用しているユーザのユーザ名。
oldpassword ユーザの古いパスワード。
newpassword 新しいパスワード。
説明

この関数は、Caché 認証が使用されている場合、ユーザのパスワードを変更できます。LDAP、DELEGATED、Kerberos やその他の形式の認証では有効ではありません。コールイン・セッションが初期化される前に呼び出される必要があります。典型的な使用法は、CacheSecureStart からの CACHE_CHANGEPASSWORD エラーを処理することです。この場合、パスワードを変更するために CacheChangePassword が呼び出され、それから CacheSecureStart が再度呼び出されます。

CacheChangePasswordA の返り値

CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_SUCCESS パスワードが変更されました。

CacheChangePasswordH

バリアント : CacheChangePasswordACacheChangePasswordW

int CacheChangePasswordH(CACHEHSTRP username, CACHEHSTRP oldpassword, CACHEHSTRP newpassword)
引数

username 変更が必要なパスワードを使用しているユーザのユーザ名。
oldpassword ユーザの古いパスワード。
newpassword 新しいパスワード。
説明

この関数は、Caché 認証が使用されている場合、ユーザのパスワードを変更できます。LDAP、DELEGATED、Kerberos やその他の形式の認証では有効ではありません。コールイン・セッションが初期化される前に呼び出される必要があります。典型的な使用法は、CacheSecureStart からの CACHE_CHANGEPASSWORD エラーを処理することです。この場合、パスワードを変更するために CacheChangePassword が呼び出され、それから CacheSecureStart が再度呼び出されます。

CacheChangePasswordH の返り値

CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_SUCCESS パスワードが変更されました。

CacheChangePasswordW

バリアント : CacheChangePasswordACacheChangePasswordH

int CacheChangePasswordW(CACHEWSTRP username, CACHEWSTRP oldpassword, CACHEWSTRP newpassword)
引数

username 変更が必要なパスワードを使用しているユーザのユーザ名。
oldpassword ユーザの古いパスワード。
newpassword 新しいパスワード。
説明

この関数は、Caché 認証が使用されている場合、ユーザのパスワードを変更できます。LDAP、DELEGATED、Kerberos やその他の形式の認証では有効ではありません。コールイン・セッションが初期化される前に呼び出される必要があります。典型的な使用法は、CacheSecureStart からの CACHE_CHANGEPASSWORD エラーを処理することです。この場合、パスワードを変更するために CacheChangePassword が呼び出され、それから CacheSecureStart が再度呼び出されます。

CacheChangePasswordW の返り値

CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_SUCCESS パスワードが変更されました。

CacheCloseOref

int CacheCloseOref(unsigned int oref)
引数

oref オブジェクト参照。
説明

OREF に対するシステム参照カウンタをデクリメントします。

CacheCloseOref の返り値

CACHE_ERBADOREF OREF が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CacheContext

int CacheContext()
説明

関数値として整数を返します。

($ZF 関数から呼び出されたモジュールとは対照的に) 外部コールイン・プログラムを使用していて、このプログラムが AST または独立したスレッドを使用している場合、CacheContext は、接続の Caché 側に現在処理中の要求が存在するかどうかを返します。これは、処理を完了させるには、Caché に戻る必要があるかどうかを判断するために必要な情報です。

CacheContext の返り値

-1 $ZF コールバック経由で Caché に作成されました。
0 現在、接続がありません。あるいは、Caché に入っていません。
1 外部接続 (例えば、$ZF ではない接続) から Caché に入りました。終了ハンドラなどの AST (非同期システム・トラップ) は、Caché が処理を完了できるように Caché に返す必要があります。
Note:

$ZF 関数にプログラムと AST のどちらから入ったかという情報が必要なのは、AST からの場合、処理を完了させるには Caché に戻る必要があるからです。

rc = CacheContext();

CacheConvert

int CacheConvert(unsigned long type, void * rbuf)
引数

type #define で定義された型。以下の有効な値を持ちます。
rbuf このデータ型に適したサイズのデータ領域のアドレス。型が CACHE_ASTRING の場合、rbuf は、結果を含む CACHE_ASTR 構造のアドレスになります。また、この構造の len 要素には、返される文字列の最大サイズ (文字数) を表す値を入力する必要があります。同様に、型が CACHE_WSTRING である場合、rbuf は、CACHEWSTR 構造のアドレスになります。この構造の len 要素には、最大サイズを表す値 (文字数) を入力する必要があります。
説明

CacheEval で返された値を適切な形式に変換し、その返り値 (以下の rbuf を参照) を指定されたアドレスに置きます。

有効な type の値は以下のとおりです。

  • CACHE_ASTRING — 8 ビット文字列

  • CACHE_CHAR — 8 ビット符号付整数

  • CACHE_DOUBLE — 64 ビット浮動小数点

  • CACHE_FLOAT — 32 ビット浮動小数点

  • CACHE_INT — 32 ビット符号付整数

  • CACHE_INT2 — 16 ビット符号付整数

  • CACHE_INT4 — 32 ビット符号付整数

  • CACHE_INT8 — 64 ビット符号付整数

  • CACHE_UCHAR — 8 ビット符号なし整数

  • CACHE_UINT — 32 ビット符号なし整数

  • CACHE_UINT2 — 16 ビット符号なし整数

  • CACHE_UINT4 — 32 ビット符号なし整数

  • CACHE_UINT8 — 64 ビット符号なし整数

  • CACHE_WSTRING — Unicode 文字列

CacheConvert の返り値

CACHE_BADARG 型が無効です。
CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_NOCON 接続が確立されていません。
CACHE_NORES 返すことができるタイプを持つ結果がありません (この呼び出しの前に、CacheEvalA が呼び出されていません)。
CACHE_RETTRUNC 成功しました。しかし、タイプ CACHE_ASTRING、CACHE_INT8、CACHE_UINT8、および CACHE_WSTRING は、retval に割り当てられた領域に収まらない値を返しました。つまり、CACHE_INT8、CACHE_UINT8 に対し、式の浮動小数点数が、64 ビットに適応するように正規化されなかったことを意味します。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 最後の CacheEval で返された値は、適切に変換されました。
Note:

Caché は、(負の指数を含む) 小数部を持つ浮動小数点タイプ CACHE_FLOAT と CACHE_DOUBLE、および 64 ビット整数タイプ (CACHE_INT8 と CACHE_UINT8) の返り値の算出時、除算を実行します。したがって、元の値とは異なる値が返される可能性があります。 CACHE_ASTRING、CACHE_INT8、CACHE_UINT8、および CACHE_WSTRING は、CACHE_RETTRUNC の状態を返すことができます。

CACHE_ASTR retval; 
/* define variable retval */

retval.len = 20; 
/* maximum return length of string */

rc = CacheConvert(CACHE_ASTRING,&retval);

CacheCtrl

int CacheCtrl(unsigned long flags)
引数

flags 特定のキーストロークが、Caché でどのように処理されるかを表す 2 種類の #define 値のどちらかになります。
説明

Caché が CTRL-C を無視するかどうかを決定します。flags は、以下に関するビット状態値を持つことができます。

  • CACHE_DISACTRLC — Caché は CTRL-C を無視します。

  • CACHE_ENABCTRLCBREAK コマンドまたは OPEN コマンドでオーバーライドされていない限り、関数が呼び出されない場合の既定値として使用されます。Caché では、CTRL-C は <INTERRUPT> を生成します。

CacheCtrl の返り値

CACHE_FAILURE (コールイン実行可能プログラムの内部からではなく) $ZF 関数から呼び出された場合に返されます。
CACHE_SUCCESS 制御関数が実行されました。

rc = CacheCtrl(CACHE_ENABCTRLC);

CacheCvtExStrInA

バリアント : CacheCvtExStrInWCacheCvtExStrInH

int CacheCvtExStrInA(CACHE_EXSTRP src, CACHE_ASTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の 8 ビット・バージョンで内部的にのみ使用されるローカルの 8 ビット文字列エンコーディングに変換します。

CacheCvtExStrInA の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED Unicode では使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtExStrInW

バリアント : CacheCvtExStrInACacheCvtExStrInH

int CacheCvtExStrInW(CACHE_EXSTRP src, CACHEWSTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の Unicode バージョンで内部的に使用される 2 バイトの Unicode 文字列エンコーディングに変換します。

CacheCvtExStrInW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtExStrInH

バリアント : CacheCvtExStrInACacheCvtExStrInW

int CacheCvtExStrInH(CACHE_EXSTRP src, CACHEWSTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の Unicode バージョンで内部的に使用される 4 バイトの Unicode 文字列エンコーディングに変換します。

CacheCvtExStrInH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtExStrOutA

バリアント : CacheCvtExStrOutWCacheCvtExStrOutH

int CacheCvtExStrOutA(CACHE_EXSTRP src, CACHE_ASTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

Caché の 8 ビット製品で内部的に使用されるローカルの 8 ビット文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します (これは、Caché の 8 ビット・バージョンでのみ使用可能です)。

CacheCvtExStrOutA の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED Unicode では使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtExStrOutW

バリアント : CacheCvtExStrOutACacheCvtExStrOutH

int CacheCvtExStrOutW(CACHE_EXSTRP src, CACHEWSTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

Caché の Unicode バージョンで内部的に使用される 2 バイトの Unicode 文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の Unicode バージョンでのみ使用可能です)。

CacheCvtExStrOutW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtExStrOutH

バリアント : CacheCvtExStrOutACacheCvtExStrOutW

int CacheCvtExStrOutH(CACHE_EXSTRP src, CACHEWSTRP tbl, CACHE_EXSTRP res)
引数

src 変換する文字列を含む CACHE_EXSTRP 変数のアドレスです。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 結果を含む CACHE_EXSTRP 変数のアドレスです。
説明

Caché の Unicode バージョンで内部的に使用される 4 バイトの Unicode 文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の Unicode バージョンでのみ使用可能です)。

CacheCvtExStrOutH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtInA

バリアント : CacheCvtInWCacheCvtInH

int CacheCvtInA(CACHE_ASTRP src, CACHE_ASTRP tbl, CACHE_ASTRP res)
引数

src 変換される外部文字セット・エンコーディング内の文字列です (文字列カウント・バッファを使用して表されます)。この文字列は、例えば、出力として予想される最大文字数を表す空白の数を値に設定し、初期化しておく必要があります。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res 8 ビット文字列カウントの結果を含む CACHE_ASTR 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の 8 ビット・バージョンで内部的にのみ使用されるローカルの 8 ビット文字列エンコーディングに変換します。

CacheCvtInA の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED Unicode では使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtInH

バリアント : CacheCvtInACacheCvtInW

int CacheCvtInH(CACHE_ASTRP src, CACHEHSTRP tbl, CACHEHSTRP res)
引数

src 外部文字セット・エンコーディングで表現した変換対象の文字列です (Unicode 文字列を保持するために必要なバイト数のサイズで表記されます)。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res Unicode 計算文字列カウントの結果を含む CACHEHSTRP 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の Unicode バージョンで内部的に使用される Unicode 文字列エンコーディングに変換します。

CacheCvtInH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtInW

バリアント : CacheCvtInACacheCvtInH

int CacheCvtInW(CACHE_ASTRP src, CACHEWSTRP tbl, CACHEWSTRP res)
引数

src 外部文字セット・エンコーディングで表現した変換対象の文字列です (Unicode 文字列を保持するために必要なバイト数のサイズで表記されます)。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res Unicode 計算文字列カウントの結果を含む CACHEWSTR 変数のアドレスです。
説明

指定の外部文字セット・エンコーディングを持つ文字列を、Caché の Unicode バージョンで内部的に使用される Unicode 文字列エンコーディングに変換します。

CacheCvtInW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtOutA

バリアント : CacheCvtOutWCacheCvtOutH

int CacheCvtOutA(CACHE_ASTRP src, CACHE_ASTRP tbl, CACHE_ASTRP res)
引数

src Caché の 8 ビット製品で内部的に使用されるローカルの 8 ビット文字列エンコーディングの文字列です (NULL ポインタが渡される場合、Caché は、CacheEvalA または CacheEvalW に対する最新の呼び出しからの結果を使用します)。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res ターゲットの外部文字セット・エンコーディングで表現した結果 (8 ビット文字列バッファのカウントのサイズで表記) を含む CACHE_ASTR 変数のアドレスです。
説明

Caché の 8 ビット製品で内部的に使用されるローカルの 8 ビット文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します (これは、Caché の 8 ビット・バージョンでのみ使用可能です)。

CacheCvtOutA の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED Unicode では使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtOutH

バリアント : CacheCvtOutACacheCvtOutW

int CacheCvtOutH(CACHEHSTRP src, CACHEHSTRP tbl, CACHE_ASTRP res)
引数

src Caché Unicode 製品で内部的に使用される Unicode 文字列エンコーディングの文字列です (NULL ポインタが渡される場合、Caché は、CacheEvalA あるいは CacheEvalW に対する最新の呼び出しからの結果を使用します)。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res ターゲットの外部文字セット・エンコーディングで表現した結果 (8 ビット文字列バッファのカウントのサイズで表記) を含む CACHE_ASTR 変数のアドレスです。
説明

Caché の Unicode バージョンで内部的に使用される Unicode 文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の Unicode バージョンでのみ使用可能です)。

CacheCvtOutH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheCvtOutW

バリアント : CacheCvtOutACacheCvtOutH

int CacheCvtOutW(CACHEWSTRP src, CACHEWSTRP tbl, CACHE_ASTRP res)
引数

src Caché Unicode 製品で内部的に使用される Unicode 文字列エンコーディングの文字列です (NULL ポインタが渡される場合、Caché は、CacheEvalA あるいは CacheEvalW に対する最新の呼び出しからの結果を使用します)。
tbl 変換を実行するために使用する入出力変換テーブル名です (NULL 文字列の場合、既定処理で入出力変換テーブル名を使用する必要があることを示します)。
res ターゲットの外部文字セット・エンコーディングで表現した結果 (8 ビット文字列バッファのカウントのサイズで表記) を含む CACHE_ASTR 変数のアドレスです。
説明

Caché の Unicode バージョンで内部的に使用される Unicode 文字列エンコーディングからの文字列を、指定の外部文字セット・エンコーディングを持つ文字列に変換します(これは、Caché の Unicode バージョンでのみ使用可能です)。

CacheCvtOutW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_ERRUNIMPLEMENTED 8 ビット・システムでは使用できません。
CACHE_ERVALUE 指定の入出力変換テーブル名は未定義であるか、あるいは入力コンポーネントがありませんでした。
CACHE_ERXLATE 入力文字列は、指定の入出力変換テーブルを使用して変換できませんでした。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTRUNC 結果用のバッファが小さすぎたため、結果が切り捨てられました。
CACHE_FAILURE 変換データ構造の構築中にエラーが発生しました (パーティション・メモリ不足の場合があります)。
CACHE_SUCCESS 変換が正常に完了しました。

CacheDoFun

int CacheDoFun(unsigned int flags, int narg)
引数

flags CachePushRtn[XW] からのルーチン・フラグ。
narg 引数スタックにプッシュされた呼び出し引数の数。ターゲットには、(できるだけ空の) 仮パラメータ・リストが必要です。
説明

ルーチン呼び出しを実行します (特殊な場合)。

CacheDoFun の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_FAILURE 内部的な整合性にエラーがあります。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheDoRtn

int CacheDoRtn(unsigned int flags, int narg)
引数

flags CachePushRtn[XW] からのルーチン・フラグ。
narg 引数スタックにプッシュされた呼び出し引数の数。0 の場合、ターゲットは仮パラメータ・リストを持つことができません。
説明

ルーチン呼び出しを実行します。

CacheDoRtn の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_FAILURE 内部的な整合性にエラーがあります。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheEnd

int CacheEnd()
説明

Caché プロセスを終了します。切断された接続が存在する場合は、削除操作も行います。

CacheEnd の返り値

CACHE_FAILURE (コールイン実行可能プログラムの内部からではなく) $ZF 関数から呼び出された場合に返されます。
CACHE_NOCON 接続が確立されていません。
CACHE_SUCCESS Caché セッションが終了、あるいは削除されました。

CacheEnd は、任意の Caché エラー・コードを返すこともできます。

rc = CacheEnd();

CacheEndAll

int CacheEndAll()
説明

スレッド・コールイン環境のすべてのスレッドを切断してから、スレッドが終了するようにスケジュールし、それらのスレッドが終了するまで待機します。

CacheEndAll の返り値

CACHE_SUCCESS Caché セッションが終了、あるいは削除されました。

rc = CacheEndAll();

CacheErrorA

バリアント : CacheErrorWCacheErrorH

int CacheErrorA(CACHE_ASTRP msg, CACHE_ASTRP src, int * offp)
引数

msg エラー・メッセージ、またはエラー・メッセージを受信する変数のアドレス。
src エラーのソース文字列、またはエラー・メッセージのソース文字列を受信する変数のアドレス。
offp errsrc の位置に対するオフセットを指定する整数、またはエラー・メッセージのソース文字列に対するオフセットを受信する整数のアドレス。
説明

最新のエラー・メッセージ、それに関連付けられたソース文字列、およびそのソース文字列の中でエラーが発生した箇所までのオフセットを返します。

CacheErrorA の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL errmsg または errsrc の返り値の長さが有効なサイズではありませんでした。
CACHE_SUCCESS 接続が確立されました。

CACHE_ASTR errmsg;
CACHE_ASTR srcline;
int offset;
errmsg.len = 50;
srcline.len = 100;
if ((rc = CacheErrorA(&errmsg, &srcline, &offset)) != CACHE_SUCCESS)
printf("\r\nfailed to display error - rc = %d",rc);

CacheErrorH

バリアント : CacheErrorACacheErrorW

int CacheErrorH(CACHEHSTRP msg, CACHEHSTRP src, int * offp)
引数

msg エラー・メッセージ、またはエラー・メッセージを受信する変数のアドレス。
src エラーのソース文字列、またはエラー・メッセージのソース文字列を受信する変数のアドレス。
offp errsrc の位置に対するオフセット、またはエラー・メッセージのソース文字列に対するオフセットを受信する整数のアドレス。
説明

最新のエラー・メッセージ、それに関連付けられたソース文字列、およびそのソース文字列の中でエラーが発生した箇所までのオフセットを返します。

CacheErrorH の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL errmsg または errsrc の返り値の長さが有効なサイズではありませんでした。
CACHE_SUCCESS 接続が確立されました。

CACHEHSTRP errmsg;
CACHEHSTRP srcline;
int offset;
errmsg.len = 50;
srcline.len = 100;
if ((rc = CacheErrorH(&errmsg, &srcline, &offset)) != CACHE_SUCCESS)
printf("\r\nfailed to display error - rc = %d",rc);

CacheErrorW

バリアント : CacheErrorACacheErrorH

int CacheErrorW(CACHEWSTRP msg, CACHEWSTRP src, int * offp)
引数

msg エラー・メッセージ、またはエラー・メッセージを受信する変数のアドレス。
src エラーのソース文字列、またはエラー・メッセージのソース文字列を受信する変数のアドレス。
offp errsrc の位置に対するオフセット、またはエラー・メッセージのソース文字列に対するオフセットを受信する整数のアドレス。
説明

最新のエラー・メッセージ、それに関連付けられたソース文字列、およびそのソース文字列の中でエラーが発生した箇所までのオフセットを返します。

CacheErrorW の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL errmsg または errsrc の返り値の長さが有効なサイズではありませんでした。
CACHE_SUCCESS 接続が確立されました。

CACHEWSTRP errmsg;
CACHEWSTRP srcline;
int offset;
errmsg.len = 50;
srcline.len = 100;
if ((rc = CacheErrorW(&errmsg, &srcline, &offset)) != CACHE_SUCCESS)
printf("\r\nfailed to display error - rc = %d",rc);

CacheErrxlateA

バリアント : CacheErrxlateWCacheErrxlateH

int CacheErrxlateA(int code, CACHE_ASTRP rbuf)
引数

code エラー・コードです。
rbuf Caché エラー文字列を含む CACHE_ASTR 変数のアドレスです。len フィールドには、返される文字列の最大サイズをロードする必要があります。
説明

エラー・コード code を Cache エラー文字列に変換し、その文字列を rbuf で示す構造に書き込みます。

CacheErrxlateA の返り値

CACHE_ERUNKNOWN 指定のコードは、(コールイン・インタフェース・エラー範囲で) 1 より小さいか、最大の Caché エラー番号より大きくなっています。
CACHE_RETTRUNC 関連するエラー文字列は、割り当てられる場所に収まるように切り捨てられます。
CACHE_SUCCESS 接続が確立されました。

CACHE_ASTR retval; /* define variable retval */
retval.len = 30; /* maximum return length of string */
rc = CacheErrxlateA(CACHE_ERSTORE,&retval);

CacheErrxlateH

バリアント : CacheErrxlateACacheErrxlateW

int CacheErrxlateH(int code, CACHEHSTRP rbuf)
引数

code エラー・コードです。
rbuf Caché エラー文字列を含む CACHEHSTRP 変数のアドレスです。len フィールドには、返される文字列の最大サイズをロードする必要があります。
説明

エラー・コード code を Cache エラー文字列に変換し、その文字列を rbuf で示す構造に書き込みます。

CacheErrxlateH の返り値

CACHE_ERUNKNOWN 指定のコードは、(コールイン・インタフェース・エラー範囲で) 1 より小さいか、最大の Caché エラー番号より大きくなっています。
CACHE_RETTRUNC 関連するエラー文字列は、割り当てられる場所に収まるように切り捨てられます。
CACHE_SUCCESS 接続が確立されました。

CACHEHSTR retval; /* define variable retval */
retval.len = 30; /* maximum return length of string */
rc = CacheErrxlateH(CACHE_ERSTORE,&retval);

CacheErrxlateW

バリアント : CacheErrxlateACacheErrxlateH

int CacheErrxlateW(int code, CACHEWSTRP rbuf)
引数

code エラー・コードです。
rbuf Caché エラー文字列を含む CACHEWSTR 変数のアドレスです。len フィールドには、返される文字列の最大サイズをロードする必要があります。
説明

エラー・コード code を Cache エラー文字列に変換し、その文字列を rbuf で示す構造に書き込みます。

CacheErrxlateW の返り値

CACHE_ERUNKNOWN 指定のコードは、(コールイン・インタフェース・エラー範囲で) 1 より小さいか、最大の Caché エラー番号より大きくなっています。
CACHE_RETTRUNC 関連するエラー文字列は、割り当てられる場所に収まるように切り捨てられます。
CACHE_SUCCESS 接続が確立されました。

CACHEWSTR retval; /* define variable retval */
retval.len = 30; /* maximum return length of string */
rc = CacheErrxlateW(CACHE_ERSTORE,&retval);

CacheEvalA

バリアント : CacheEvalWCacheEvalH

int CacheEvalA(CACHE_ASTRP volatile expr)
引数

expr CACHE_ASTR 変数のアドレス。
説明

文字列を、それが Caché の式であるかのように評価し、返り値をメモリに格納して、CacheTypeCacheConvert による処理がさらに進められるようにします。

CacheEvalA が正常に完了した場合、CacheTypeCacheConvert への呼び出しが完了するようにフラグがセットされます。これらの関数は、CacheEvalA から返される項目の処理に使用されます。

Caution:

次に、CacheEvalACacheExecuteA、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheEvalA の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHE_ERSYSTEM Caché が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に評価されました。

CacheEvalA は、任意の Caché エラー・コードを返すこともできます。

int rc;
CACHE_ASTR retval;
CACHE_ASTR expr;

strcpy(expr.str, "\"Record\"_^Recnum_\" = \"_$$^GetRec(^Recnum)");
expr.len = strlen(expr.str);
rc = CacheEvalA(&expr);
if (rc == CACHE_SUCCESS) 
    rc = CacheConvert(CACHE_ASTRING,&retval);

CacheEvalH

バリアント : CacheEvalACacheEvalW

int CacheEvalH(CACHEHSTRP volatile expr)
引数

expr CACHEHSTRP 変数のアドレス。
説明

文字列を、それが Caché の式であるかのように評価し、返り値をメモリに格納して、CacheTypeCacheConvert による処理がさらに進められるようにします。

CacheEvalH が正常に完了した場合、CacheTypeCacheConvert への呼び出しが完了するようにフラグがセットされます。これらの関数は、CacheEvalA から返される項目の処理に使用されます。

Caution:

次に、CacheEvalHCacheExecuteH、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheEvalH の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHW_ERSYSTEM Caché が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に評価されました。

CacheEvalH は、任意の Caché エラー・コードを返すこともできます。

int rc;
CACHEHSTRP retval; 
CACHEHSTRP expr;

strcpy(expr.str, "\"Record\"_^Recnum_\" = \"_$$^GetRec(^Recnum)");
expr.len = strlen(expr.str);
rc = CacheEvalH(&expr);
if (rc == CACHE_SUCCESS) 
    rc = CacheConvert(ING,&retval);

CacheEvalW

バリアント : CacheEvalACacheEvalH

int CacheEvalW(CACHEWSTRP volatile expr)
引数

expr CACHEWSTR 変数のアドレス。
説明

文字列を、それが Caché の式であるかのように評価し、返り値をメモリに格納して、CacheTypeCacheConvert による処理がさらに進められるようにします。

CacheEvalW が正常に完了した場合、CacheTypeCacheConvert への呼び出しが完了するようにフラグがセットされます。これらの関数は、CacheEvalA から返される項目の処理に使用されます。

Caution:

次に、CacheEvalWCacheExecuteW、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheEvalW の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHW_ERSYSTEM Caché が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に評価されました。

CacheEvalW は、任意の Caché エラー・コードを返すこともできます。

int rc;
CACHEWSTR retval; 
CACHEWSTR expr;

strcpy(expr.str, "\"Record\"_^Recnum_\" = \"_$$^GetRec(^Recnum)");
expr.len = strlen(expr.str);
rc = CacheEvalW(&expr);
if (rc == CACHE_SUCCESS) 
    rc = CacheConvert(ING,&retval);

CacheExecuteA

バリアント : CacheExecuteWCacheExecuteH

int CacheExecuteA(CACHE_ASTRP volatile cmd)
引数

cmd CACHE_ASTR 変数のアドレス。
説明

Caché のプログラマ・プロンプトで入力されたかのように、コマンド文字列を実行します。

Caution:

次に、CacheEvalACacheExecuteA、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheExecuteA の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に実行されました。

CacheExecuteA は、任意の Caché エラー・コードを返すこともできます。

int rc;
CACHE_ASTR command;
sprintf(command.str,"ZN \"USER\""); /* changes namespace */
command.len = strlen(command.str);
rc = CacheExecuteA(&command);

CacheExecuteH

バリアント : CacheExecuteACacheExecuteW

int CacheExecuteH(CACHEHSTRP volatile cmd)
引数

cmd CACHE_ASTR 変数のアドレス。
説明

Caché のプログラマ・プロンプトで入力されたかのように、コマンド文字列を実行します。

CacheExecuteH が正常に完了した場合、CacheTypeCacheConvert への呼び出しが完了するようにフラグがセットされます。これらの関数は、CacheEvalH から返される項目の処理に使用されます。

Caution:

次に、CacheEvalHCacheExecuteH、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheExecuteH の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に実行されました。

CacheExecuteH は、任意の Caché エラー・コードを返すこともできます。

int rc;
unsigned short zname[] = {'Z','N',' ','"','U','S','E','R','"'};
CACHEHSTRP pcommand;
pcommand.str = zname;
pcommand.len = sizeof(zname) / sizeof(unsigned short);
rc = CacheExecuteH(pcommand);

CacheExecuteW

バリアント : CacheExecuteACacheExecuteH

int CacheExecuteW(CACHEWSTRP volatile cmd)
引数

cmd CACHE_ASTR 変数のアドレス。
説明

Caché のプログラマ・プロンプトで入力されたかのように、コマンド文字列を実行します。

CacheExecuteW が正常に完了した場合、CacheTypeCacheConvert への呼び出しが完了するようにフラグがセットされます。これらの関数は、CacheEvalW から返される項目の処理に使用されます。

Caution:

次に、CacheEvalWCacheExecuteW、または CacheEnd を呼び出すと、既存の返り値が上書きされます。

CacheExecuteW の返り値

CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_NOCON 接続が確立されていません。
CACHE_STRTOOLONG 文字列が長すぎます。
CACHE_SUCCESS 文字列は、正常に実行されました。

CacheExecuteW は、任意の Caché エラー・コードを返すこともできます。

int rc;
unsigned short zname[] = {'Z','N',' ','"','U','S','E','R','"'};
CACHEWSTRP pcommand;
pcommand.str = zname;
pcommand.len = sizeof(zname) / sizeof(unsigned short);
rc = CacheExecuteW(pcommand);

CacheExStrKill

int CacheExStrKill(CACHE_EXSTRP obj)
引数

obj 文字列へのポインタ。
説明

EXSTR 文字列に関連付けられているストレージを解放します。

CacheExStrKill の返り値

CACHE_ERUNIMPLEMENTED 文字列が未定義です。
CACHE_SUCCESS 文字列のストレージが解放されました。

CacheExStrNew

バリアント : CacheExStrNewWCacheExStrNewH

unsigned char * CacheExStrNew(CACHE_EXSTRP zstr, int size)
引数

zstr CACHE_EXSTR 文字列記述子へのポインタ。
size 割り当てる 8 ビット文字の数
説明

文字列に対して要求されたストレージの容量を割り当て、EXSTR 構造に、構造の長さおよび構造の値フィールドへのポインタを埋め込みます。

CacheExStrNew の返り値

割り当てられた文字列へのポインタ、または、文字列が割り当てられていない場合は NULL を返します。

CacheExStrNewW

バリアント : CacheExStrNewCacheExStrNewH

unsigned short * CacheExStrNewW(CACHE_EXSTRP zstr, int size)
引数

zstr CACHE_EXSTR 文字列記述子へのポインタ。
size 割り当てる 2 バイト文字の数
説明

文字列に対して要求されたストレージの容量を割り当て、EXSTR 構造に、構造の長さおよび構造の値フィールドへのポインタを埋め込みます。

CacheExStrNewW の返り値

割り当てられた文字列へのポインタ、または、文字列が割り当てられていない場合は NULL を返します。

CacheExStrNewH

バリアント : CacheExStrNewCacheExStrNewW

unsigned short * CacheExStrNewH(CACHE_EXSTRP zstr, int size)
引数

zstr CACHE_EXSTR 文字列記述子へのポインタ。
size 割り当てる 4 バイト文字の数
説明

文字列に対して要求されたストレージの容量を割り当て、EXSTR 構造に、構造の長さおよび構造の値フィールドへのポインタを埋め込みます。

CacheExStrNewH の返り値

割り当てられた文字列へのポインタ、または、文字列が割り当てられていない場合は NULL を返します。

CacheExtFun

int CacheExtFun(unsigned int flags, int narg)
引数

flags CachePushFunc[XW] からのルーチン・フラグ。
narg 引数スタックにプッシュされた呼び出し引数の数。
説明

返り値を引数スタックにプッシュする外部関数呼び出しを実行します。

CacheExtFun の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_FAILURE 内部的な整合性にエラーがあります。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGetProperty

int CacheGetProperty()
説明

CachePushProperty により定義されたプロパティの値を取得します。この値は、引数スタックにプッシュされます。

CacheGetProperty の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalData

int CacheGlobalData(int narg, int valueflag)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
valueflag データ値がある場合、データ値を返すかどうかを示します。
説明

指定したグローバルに対して $Data を実行します。

CacheGlobalData の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalGet

int CacheGlobalGet(int narg, int flag)
引数

narg 引数スタックにプッシュされた添え字式の数。
flag グローバル参照が定義されていない場合の動作を指定します。
  • 0 — CACHE_ERUNDEF を返します。

  • 1 — CACHE_SUCCESS を返しますが、返り値は空の文字列になります。

説明

CachePushGlobal および任意の添え字により定義されたグローバル参照の値を取得します。このノード値は、引数スタックにプッシュされます。

CacheGlobalGet の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalGetBinary

int CacheGlobalGetBinary(int numsub, int flag, int *plen, Callin_char_t **pbuf)
引数

numsub 引数スタックにプッシュされた添え字式の数。
flag グローバル参照が定義されていない場合の動作を指定します。
  • 0 — CACHE_ERUNDEF を返します。

  • 1 — CACHE_SUCCESS を返しますが、返り値は空の文字列になります。

plen バッファの長さへのポインタ。
pbuf バッファ・ポインタへのポインタ。
説明

CachePushGlobal[W][H] および任意の添え字で定義されたグローバル参照の値を取得します。また、その結果が指定されたバッファに収まるバイナリ文字列かどうかを確認するためにテストを実行します。このノード値は、引数スタックにプッシュされます。

CacheGlobalGetBinary の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalIncrement

int CacheGlobalIncrement(int narg)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
説明

$INCREMENT を実行し、スタックの一番上の結果を返します。

CacheGlobalIncrement の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_ERMAXINCR MAXINCREMENT システム・エラー
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalKill

int CacheGlobalKill(int narg, int nodeonly)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
nodeonly 1 の値は、指定されたノードのみを強制停止することを示します。値が 0 の場合、指定されたグローバル・ツリー全体が強制停止されます。
説明

グローバル・ノードまたはツリーに対して ZKILL を実行します。

CacheGlobalKill の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalOrder

int CacheGlobalOrder(int narg, int dir, int valueflag)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
dir $Order の方向は、1 の場合は前向き、-1 は後ろ向きです。
valueflag データ値がある場合、データ値を返すかどうかを示します。
説明

指定したグローバルに対して $Order を実行します。

CacheGlobalOrder の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalQuery

int CacheGlobalQuery(int narg, int dir, int valueflag)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
dir $Query の方向は、1 の場合は前向き、-1 は後ろ向きです。
valueflag データ値がある場合、データ値を返すかどうかを示します。
説明

指定したグローバルに対して $Query を実行します。

CacheGlobalQuery の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_ERPROTECT 保護違反です。
CACHE_ERUNDEF ノードに関連付けられた値はありません。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheGlobalRelease

int CacheGlobalRelease( )
説明

保持されたグローバル・バッファの所有権 (存在する場合) を解放します。

CacheGlobalRelease の返り値

CACHE_SUCCESS 操作は正常に終了しました。

CacheGlobalSet

int CacheGlobalSet(int narg)
引数

narg 引数スタックにプッシュされた添え字式の数。
説明

CachePushGlobal および任意の添え字により定義されたグローバル参照の値を格納します。この呼び出しを行う前に、ノード値を引数スタックにプッシュしておく必要があります。

CacheGlobalSet の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheIncrementCountOref

int CacheIncrementCountOref(unsigned int oref)
引数

oref オブジェクト参照。
説明

OREF に対するシステム参照カウンタをインクリメントします。

CacheIncrementCountOref の返り値

CACHE_ERBADOREF OREF が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CacheInvokeClassMethod

int CacheInvokeClassMethod(int narg)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
説明

CachePushClassMethod[W] および任意の引数によって定義されたクラス・メソッド呼び出しを実行します。返り値は、引数スタックにプッシュされます。

CacheInvokeClassMethod の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheInvokeMethod

int CacheInvokeMethod(int narg)
引数

narg 引数スタックにプッシュされた呼び出し引数の数。
説明

CachePushMethod[W]、および引数スタックにプッシュされた任意の引数によって定義されるインスタンス・メソッド呼び出しを実行します。

CacheInvokeMethod の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheOflush

int CacheOflush()
説明

保留中の出力をすべてフラッシュします。

CacheOflush の返り値

CACHE_FAILURE (コールイン実行可能プログラムの内部からではなく) $ZF 関数から呼び出された場合に返されます。
CACHE_SUCCESS 制御関数が実行されました。

CachePop

int CachePop(void ** arg)
引数

arg 引数スタック・エントリへのポインタ。
説明

引数スタックから値をポップ・オフします。

CachePop の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopCvtH

バリアント : CachePopCvtW

int CachePopCvtH(int * lenp, wchar_t ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

引数スタックからローカルの 8 ビット文字列をポップ・オフし、4 バイト Unicode に変換します。Unicode 環境の CachePopStrH と同じです。

CachePopCvtH の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopCvtW

バリアント : CachePopCvtH

int CachePopCvtW(int * lenp, unsigned short ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

非推奨 : 長い文字列関数 CachePopExStrCvtW は、すべての文字列に使用する必要があります。

引数スタックからローカルの 8 ビット文字列をポップ・オフし、2 バイト Unicode に変換します。Unicode 環境の CachePopStrW と同じです。

CachePopCvtW の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopDbl

int CachePopDbl(double * nump)
引数

nump ダブル値へのポインタ。
説明

引数スタックから値をポップ・オフし、double 型に変換します。

CachePopDbl の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopExStr

バリアント : CachePopExStrWCachePopExStrH

int CachePopExStr(CACHE_EXSTRP sstrp)
引数

sstrp 長い文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、ローカルの 8 ビット・エンコーディングの文字列に変換します。

CachePopExStr の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。
CACHE_EXSTR_INUSE sstrpNULL に初期化されていなかった場合に返されます。

CachePopExStrCvtW

バリアント : CachePopExStrCvtH

int CachePopExStrCvtW(CACHE_EXSTRP sstr)
引数

sstr 長い文字列ポインタへのポインタ。
説明

引数スタックからローカルの 8 ビット文字列をポップ・オフし、2 バイト Unicode 文字列に変換します。Unicode システムでは、CachePopExStrW と同じです。

CachePopExStrCvtW の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopExStrCvtH

バリアント : CachePopExStrCvtW

int CachePopExStrCvtW(CACHE_EXSTRP sstr)
引数

sstr 長い文字列ポインタへのポインタ。
説明

引数スタックからローカルの 8 ビット文字列をポップ・オフし、4 バイト Unicode 文字列に変換します。Unicode システムでは、CachePopExStrH と同じです。

CachePopExStrCvtH の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopExStrW

バリアント : CachePopExStrCachePopExStrH

int CachePopExStrW(CACHE_EXSTRP sstrp)
引数

sstrp 長い文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、2 バイト Unicode 文字列に変換します。

CachePopExStrW の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
CACHE_EXSTR_INUSE sstrpNULL に初期化されていなかった場合に返されます。

CachePopExStrH

バリアント : CachePopExStrCachePopExStrW

int CachePopExStrH(CACHE_EXSTRP sstrp)
引数

sstrp 長い文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、4 バイト Unicode 文字列に変換します。

CachePopExStrH の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
CACHE_EXSTR_INUSE sstrpNULL に初期化されていなかった場合に返されます。

CachePopInt

int CachePopInt(int* nump)
引数

nump 整数値へのポインタ。
説明

引数スタックから値をポップ・オフし、integer 型に変換します。

CachePopInt の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopInt64

int CachePopInt64(long long * nump)
引数

nump long long 値へのポインタ。
説明

引数スタックから値をポップ・オフし、64 ビット (long long) 値に変換します

CachePopInt64 の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopList

int CachePopList(int * lenp, Callin_char_t ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

引数スタックから $LIST オブジェクトをポップ・オフして変換します。オブジェクトが Unicode バージョンであるか、8 ビット・バージョンであるかに応じて、文字列要素は適宜、コピーまたは変換されます。

CachePopList の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopOref

int CachePopOref(unsigned int * orefp)
引数

orefp OREF 値へのポインタ。
説明

引数スタックから OREF をポップ・オフします。

CachePopOref の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERNOOREF 結果は OREF ではありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopPtr

int CachePopPtr(void ** ptrp)
引数

ptrp 汎用ポインタへのポインタ。
説明

引数スタックから、ポインタを内部形式でポップ・オフします。

CachePopPtr の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_BADARG このエントリは、有効なポインタではありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopStr

バリアント : CachePopStrWCachePopStrH

int CachePopStr(int * lenp, Callin_char_t ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、string 型に変換します。

CachePopStr の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopStrH

バリアント : CachePopStrCachePopStrW

int CachePopStrH(int * lenp, wchar_t ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、4 バイト Unicode 文字列に変換します。

CachePopStrH の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePopStrW

バリアント : CachePopStrCachePopStrH

int CachePopStrW(int * lenp, unsigned short ** strp)
引数

lenp 文字列の長さへのポインタ。
strp 文字列ポインタへのポインタ。
説明

引数スタックから値をポップ・オフし、2 バイト Unicode 文字列に変換します。

CachePopStrW の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePromptA

バリアント : CachePromptWCachePromptH

int CachePromptA(CACHE_ASTRP rbuf)
引数

rbuf プロンプト文字列。返される文字列の最小長は 5 文字です。
説明

(“>” のない) プログラマ・プロンプトである文字列を返します。

CachePromptA の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL rbuf は、5 文字以上の長さにする必要があります。
CACHE_SUCCESS 接続が確立されました。

CACHE_ASTR retval;      /* define variable retval */
retval.len = 5;         /* maximum return length of string */
rc = CachePromptA(&retval);

CachePromptH

バリアント : CachePromptACachePromptW

int CachePromptH(CACHEHSTRP rbuf)
引数

rbuf プロンプト文字列。返される文字列の最小長は 5 文字です。
説明

(“>” のない) プログラマ・プロンプトである文字列を返します。

CachePromptH の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_FAILURE 要求は失敗しました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL rbuf は、5 文字以上の長さにする必要があります。
CACHE_SUCCESS 接続が確立されました。

CACHEHSTRP retval; /* define variable retval */
retval.len = 5; /* maximum return length of string */
rc = CachePromptH( &retval);

CachePromptW

バリアント : CachePromptACachePromptH

int CachePromptW(CACHEWSTRP rbuf)
引数

rbuf プロンプト文字列。返される文字列の最小長は 5 文字です。
説明

(“>” のない) プログラマ・プロンプトである文字列を返します。

CachePromptW の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_FAILURE 要求は失敗しました。
CACHE_NOCON 接続が確立されていません。
CACHE_RETTOOSMALL rbuf は、5 文字以上の長さにする必要があります。
CACHE_SUCCESS 接続が確立されました。

CACHEWSTR retval; /* define variable retval */
retval.len = 5; /* maximum return length of string */
rc = CacheConvertW( &retval);

CachePushClassMethod

バリアント : CachePushClassMethodWCachePushClassMethodH

int CachePushClassMethod(int clen, const Callin_char_t * cptr, 
                         int mlen, const Callin_char_t * mptr, int flg)
引数

clen クラス名の長さ (文字数)。
cptr クラス名へのポインタ。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg

メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。

説明

クラス・メソッド参照を引数スタックにプッシュします。

CachePushClassMethod の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushClassMethodH

バリアント : CachePushClassMethodCachePushClassMethodW

int CachePushClassMethodH(int clen, const wchar_t * cptr, 
                          int mlen, const wchar_t * mptr, int flg)
引数

clen クラス名の長さ (文字数)。
cptr クラス名へのポインタ。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。
説明

4 バイト Unicode クラス・メソッド参照を引数スタックにプッシュします。

CachePushClassMethodH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushClassMethodW

バリアント : CachePushClassMethodCachePushClassMethodH

int CachePushClassMethodW(int clen, const unsigned short * cptr, 
                          int mlen, const unsigned short * mptr, int flg)
引数

clen クラス名の長さ (文字数)。
cptr クラス名へのポインタ。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。
説明

2 バイト Unicode クラス・メソッド参照を引数スタックにプッシュします。

CachePushClassMethodW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushCvtH

バリアント : CachePushCvtW

int CachePushCvtH(int len, const wchar_t * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。Unicode バージョンの CachePushStrH と同じです。

CachePushCvtH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 文字列の変換によります。

CachePushCvtW

バリアント : CachePushCvtH

int CachePushCvtW(int len, const unsigned short * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

非推奨 : 長い文字列関数 CachePushExStrCvtW は、すべての文字列に使用する必要があります。

Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。Unicode バージョンの CachePushStrW と同じです。

CachePushCvtW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 文字列の変換によります。

CachePushDbl

int CachePushDbl(double num)
引数

num double 値。
説明

Caché の double 型を引数スタックにプッシュします。

CachePushDbl の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushExStr

バリアント : CachePushExStrW,CachePushExStrH

int CachePushExStr(CACHE_EXSTRP sptr)
引数

sptr 引数値へのポインタ。
説明

文字列を引数スタックにプッシュします。

CachePushExStr の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushExStrCvtW

バリアント : CachePushExStrCvtH

int CachePushExStrCvtW(CACHE_EXSTRP sptr)
引数

sptr 引数値へのポインタ。
説明

Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。

CachePushExStrCvtW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 文字列の変換によります。

CachePushExStrCvtH

バリアント : CachePushExStrCvtW

int CachePushExStrCvtH(CACHE_EXSTRP sptr)
引数

sptr 引数値へのポインタ。
説明

4 バイト Unicode 文字列をローカルの 8 ビットに変換し、引数スタックにプッシュします。

CachePushExStrCvtH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 文字列の変換によります。

CachePushExStrW

バリアント : CachePushExStrCachePushExStrH

int CachePushExStrW(CACHE_EXSTRP sptr)
引数

sptr 引数値へのポインタ。
説明

長い Unicode 文字列を引数スタックにプッシュします。

CachePushExStrW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushExStrH

バリアント : CachePushExStrCachePushExStrW

int CachePushExStrH(CACHE_EXSTRP sptr)
引数

sptr 引数値へのポインタ。
説明

4 バイト Unicode 文字列を引数スタックにプッシュします。

CachePushExStrH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushFunc

バリアント : CachePushFuncWCachePushFuncH

int CachePushFunc(unsigned int * rflag, int tlen, const Callin_char_t * tptr, 
                  int nlen, const Callin_char_t * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tagptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

外部関数参照を引数スタックにプッシュします。

CachePushFunc の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushFuncH

バリアント : CachePushFuncCachePushFuncW

int CachePushFuncH(unsigned int * rflag, int tlen, const wchar_t * tptr, 
                   int nlen, const wchar_t * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

4 バイト Unicode 外部関数参照を引数スタックにプッシュします。

CachePushFuncH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushFuncW

バリアント : CachePushFuncCachePushFuncH

int CachePushFuncW(unsigned int * rflag, int tlen, const unsigned short * tptr, 
                   int nlen, const unsigned short * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

2 バイト Unicode 外部関数参照を引数スタックにプッシュします。

CachePushFuncW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushFuncX

バリアント : CachePushFuncXWCachePushFuncXH

int CachePushFuncX(unsigned int * rflag, int tlen, const Callin_char_t * tptr, int off, 
                   int elen, const Callin_char_t * eptr, 
                   int nlen, const Callin_char_t * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

拡張外部関数参照を引数スタックにプッシュします。

CachePushFuncX の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushFuncXH

バリアント : CachePushFuncXCachePushFuncXW

int CachePushFuncXH(unsigned int * rflag, int tlen, const wchar_t * tptr, int off, 
                    int elen, const wchar_t * eptr, int nlen, const wchar_t * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

4 バイト Unicode 拡張関数ルーチン参照を引数スタックにプッシュします。

CachePushFuncXH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushFuncXW

バリアント : CachePushFuncXCachePushFuncXH

int CachePushFuncXW(unsigned int * rflag, int tlen, const unsigned short * tptr, int off, 
                    int elen, const unsigned short * eptr, 
                    int nlen, const unsigned short * nptr)
引数

rflag CacheExtFun で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

2 バイト Unicode 拡張関数ルーチン参照を引数スタックにプッシュします。

CachePushFuncXW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushGlobal

バリアント : CachePushGlobalWCachePushGlobalH

int CachePushGlobal(int nlen, const Callin_char_t * nptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
説明

グローバル参照を引数スタックにプッシュします。

CachePushGlobal の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushGlobalH

バリアント : CachePushGlobalCachePushGlobalW

intCachePushGlobalH(int nlen, const wchar_t * nptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
説明

4 バイト Unicode グローバル参照を引数スタックにプッシュします。

CachePushGlobalH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushGlobalW

バリアント : CachePushGlobalCachePushGlobalH

int CachePushGlobalW(int nlen, const unsigned short * nptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
説明

2 バイト Unicode グローバル参照を引数スタックにプッシュします。

CachePushGlobalW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushGlobalX

バリアント : CachePushGlobalXWCachePushGlobalXH

int CachePushGlobalX(int nlen, const Callin_char_t * nptr, 
                     int elen, const Callin_char_t * eptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

拡張グローバル参照を引数スタックにプッシュします。

CachePushGlobalX の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushGlobalXH

バリアント : CachePushGlobalXCachePushGlobalXW

int CachePushGlobalXH(int nlen, const wchar_t * nptr, int elen, const wchar_t * eptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

4 バイト Unicode 拡張グローバル参照を引数スタックにプッシュします。

CachePushGlobalXH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTAC 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushGlobalXW

バリアント : CachePushGlobalXCachePushGlobalXH

int CachePushGlobalXW(int nlen, const unsigned short * nptr, 
                      int elen, const unsigned short * eptr)
引数

nlen グローバル名の長さ (文字数)。
nptr グローバル名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

2 バイト Unicode 拡張グローバル参照を引数スタックにプッシュします。

CachePushGlobalXW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTAC 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushIEEEDbl

int CachePushIEEEDbl(double num)
引数

num double 値。
説明

IEEE の double 型を引数スタックにプッシュします

CachePushIEEEDbl の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushInt

int CachePushInt(int num)
引数

num 整数値。
説明

integer 型を引数スタックにプッシュします

CachePushInt の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushInt64

int CachePushInt64(long long num)
引数

num long long 値。
説明

64 ビット (long long) 値を引数スタックにプッシュします。

CachePushInt64 の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushList

int CachePushList(int len, const Callin_char_t * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

$LIST オブジェクトを変換し、引数スタックにプッシュします。オブジェクトが Unicode バージョンであるか、8 ビット・バージョンであるかに応じて、文字列要素は適宜、コピーまたは変換されます。

CachePushList の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 文字列要素の変換によります。

CachePushLock

バリアント : CachePushLockWCachePushLockH

int CachePushLock(int nlen, const Callin_char_t * nptr)
引数

nlen ロック名の長さ (バイト単位)
nptr ロック名へのポインタ。
説明

ロック名を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLock の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushLockH

バリアント : CachePushLockCachePushLockW

int CachePushLockH(int nlen, const wchar_t * nptr)
引数

nlen ロック名の長さ (2 バイトまたは 4 バイト文字の数)
nptr ロック名へのポインタ。
説明

ロック名を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLockH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushLockW

バリアント : CachePushLockCachePushLockH

int CachePushLockW(int nlen, const unsigned short * nptr)
引数

nlen ロック名の長さ (2 バイト文字の数)
nptr ロック名へのポインタ。
説明

ロック名を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLockW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushLockX

バリアント : CachePushLockXWCachePushLockXH

int CachePushLockX(int nlen, const Callin_char_t * nptr, int elen, const Callin_char_t * eptr)
引数

nlen ロック名の長さ (8 ビット文字の数)
nptr ロック名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。名前の形式は <ネームスペース>^[<システム>]^<ディレクトリ> にする必要があります。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

ロック名と環境文字列を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLockX の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushLockXH

バリアント : CachePushLockXCachePushLockXW

int CachePushLockXH(int nlen, const wchar_t * nptr, int elen, const wchar_t * eptr)
引数

nlen ロック名の長さ (2 バイトまたは 4 バイト文字の数)
nptr ロック名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。名前の形式は <ネームスペース>^[<システム>]^<ディレクトリ> にする必要があります。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

ロック名と環境文字列を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLockXH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushLockXW

バリアント : CachePushLockXCachePushLockXH

int CachePushLockXW(int nlen, const unsigned short * nptr, int elen, const unsigned short * eptr)
引数

nlen ロック名の長さ (2 バイト文字の数)
nptr ロック名へのポインタ。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。名前の形式は <ネームスペース>^[<システム>]^<ディレクトリ> にする必要があります。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

ロック名と環境文字列を引数スタックにプッシュすることにより、CacheAcquireLock コマンドを初期化します。

CachePushLockXW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushMethod

バリアント : CachePushMethodWCachePushMethodH

int CachePushMethod(unsigned int oref, int mlen, const Callin_char_t * mptr, int flg)
引数

oref オブジェクト参照。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。
説明

インスタンス・メソッド参照を引数スタックにプッシュします。

CachePushMethod の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushMethodH

バリアント : CachePushMethodCachePushMethodW

int CachePushMethodH(unsigned int oref, int mlen, const wchar_t * mptr, int flg)
引数

oref オブジェクト参照。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。
説明

4 バイト Unicode インスタンス・メソッド参照を引数スタックにプッシュします。

CachePushMethodH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushMethodW

バリアント : CachePushMethodCachePushMethodH

int CachePushMethodW(unsigned int oref, int mlen, const unsigned short * mptr, int flg)
引数

oref オブジェクト参照。
mlen メソッド名の長さ (文字数)。
mptr メソッド名へのポインタ。
flg メソッドが値を返すかどうかを指定します。メソッドが値を返す場合、値を取得するにはこのフラグを 1 に設定する必要があります。このメソッドは、引数付きの Quit を使用して値を返す必要があります。値を返さない場合は、このパラメータを 0 に設定します。
説明

2 バイト Unicode インスタンス・メソッド参照を引数スタックにプッシュします。

CachePushMethodW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushOref

int CachePushOref(unsigned int oref)
引数

oref オブジェクト参照。
説明

OREF を引数スタックにプッシュします。

CachePushOref の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERBADOREF OREF が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushProperty

バリアント : CachePushPropertyWCachePushPropertyH

int CachePushProperty(unsigned int oref, int plen, const Callin_char_t * pptr)
引数

oref オブジェクト参照。
plen プロパティ名の長さ (文字数)。
pptr プロパティ名へのポインタ。
説明

プロパティ参照を引数スタックにプッシュします。

CachePushProperty の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushPropertyH

バリアント : CachePushPropertyCachePushPropertyW

int CachePushPropertyH(unsigned int oref, int plen, const wchar_t * pptr)
引数

oref オブジェクト参照。
plen プロパティ名の長さ (文字数)。
pptr プロパティ名へのポインタ。
説明

4 バイト Unicode プロパティ参照を引数スタックにプッシュします。

CachePushPropertyH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushPropertyW

バリアント : CachePushPropertyCachePushPropertyH

int CachePushPropertyW(unsigned int oref, int plen, const unsigned short * pptr)
引数

oref オブジェクト参照。
plen プロパティ名の長さ (文字数)。
pptr プロパティ名へのポインタ。
説明

2 バイト Unicode プロパティ参照を引数スタックにプッシュします。

CachePushPropertyW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_BADARG 呼び出し引数が不正です。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushPtr

int CachePushPtr(void * ptr)
引数

ptr 汎用ポインタ。
説明

ポインタを内部形式で引数スタックにプッシュします。

CachePushPtr の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushRtn

バリアント : CachePushRtnWCachePushRtnH

int CachePushRtn(unsigned int * rflag, int tlen, const Callin_char_t * tptr, 
                 int nlen, const Callin_char_t * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

ルーチン参照を引数スタックにプッシュします。すべての引数を受け付けるバージョンについては、CachePushRtnX を参照してください。これは、タグ名とルーチン名のみを受け付ける短い形式の関数です。

CachePushRtn の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushRtnH

バリアント : CachePushRtnCachePushRtnW

int CachePushRtnH(unsigned int * rflag, int tlen, const wchar_t * tptr, 
                  int nlen, const wchar_t * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

4 バイト Unicode ルーチン参照を引数スタックにプッシュします。すべての引数を受け付けるバージョンについては、CachePushRtnXH を参照してください。これは、タグ名とルーチン名のみを受け付ける短い形式の関数です。

CachePushRtnH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushRtnW

バリアント : CachePushRtnCachePushRtnH

int CachePushRtnW(unsigned int * rflag, int tlen, const unsigned short * tptr, 
                  int nlen, const unsigned short * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

2 バイト Unicode ルーチン参照を引数スタックにプッシュします。すべての引数を受け付けるバージョンについては、CachePushRtnXW を参照してください。これは、タグ名とルーチン名のみを受け付ける短い形式の関数です。

CachePushRtnW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushRtnX

バリアント : CachePushRtnXWCachePushRtnXH

int CachePushRtnX(unsigned int * rflag, int tlen, const Callin_char_t * tptr, 
                  int off, int elen, const Callin_char_t * eptr, 
                  int nlen, const Callin_char_t * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

拡張ルーチン参照を引数スタックにプッシュします。タグ名とルーチン名のみを受け付ける短い形式については、CachePushRtn を参照してください。

CachePushRtnX の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushRtnXH

バリアント : CachePushRtnXCachePushRtnXW

int CachePushRtnXH(unsigned int * rflag, int tlen, const wchar_t * tptr, 
                   int off, int elen, const wchar_t * eptr, 
                   int nlen, const wchar_t * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

4 バイト Unicode 拡張ルーチン参照を引数スタックにプッシュします。タグ名とルーチン名のみを受け付ける短い形式については、CachePushRtnH を参照してください。

CachePushRtnXH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushRtnXW

バリアント : CachePushRtnXCachePushRtnXH

int CachePushRtnXW(unsigned int * rflag, int tlen, const unsigned short * tptr, 
                   int off, int elen, const unsigned short * eptr, 
                   int nlen, const unsigned short * nptr)
引数

rflag CacheDoRtn で使用するためのルーチン・フラグ。
tlen タグ名の長さ (文字数)。ここで、0 はタグ名が NULL ("") であることを表します。
tptr タグ名へのポインタ。tlen == 0 の場合、tptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
off 指定されたタグからの行オフセット。ここで、0 はオフセットがないことを表します。
elen 環境名の長さ (文字数)。ここで、0 は指定された環境がなく、この関数では現在の環境が使用されることを表します。
eptr 環境名へのポインタ。elen == 0 の場合、eptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
nlen ルーチン名の長さ (文字数)。ここで、0 はルーチン名が NULL ("") で、現在のルーチン名が使用されることを表します。
nptr ルーチン名へのポインタ。nlen == 0 の場合、nptr は使用されず、(void *) 0 がポインタ値として使用される場合があります。
説明

2 バイト Unicode 拡張ルーチン参照を引数スタックにプッシュします。タグ名とルーチン名のみを受け付ける短い形式については、CachePushRtnW を参照してください。

CachePushRtnXW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CachePushStr

バリアント : CachePushStrWCachePushStrH

int CachePushStr(int len, const Callin_char_t * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

バイト文字列を引数スタックにプッシュします。

CachePushStr の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushStrH

バリアント : CachePushStrCachePushStrW

int CachePushStrH(int len, const wchar_t * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

4 バイト Unicode 文字列を引数スタックにプッシュします。

CachePushStrH の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushStrW

バリアント : CachePushStrCachePushStrH

int CachePushStrW(int len, const unsigned short * ptr)
引数

len 文字列内の文字数。
ptr 文字列へのポインタ。
説明

2 バイト Unicode 文字列を引数スタックにプッシュします。

CachePushStrW の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CachePushUndef

int CachePushUndef()
説明

未定義値を引数スタックにプッシュします。この値は省略された関数引数として解釈されます。

CachePushUndef の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。

CacheReleaseAllLocks

int CacheReleaseAllLocks( )
説明

引数なしの Cache LOCK コマンドを実行して、プロセスによって現在保持されているロックをすべて削除します。

CacheReleaseAllLocks の返り値

CACHE_SUCCESS 操作は正常に終了しました。

CacheReleaseLock

int CacheReleaseLock(int nsub, int flg)
引数

nsub ロック参照にある添え字の数
flg ロック・コマンドの修飾語有効な値は、CACHE_IMMEDIATE_RELEASE と CACHE_SHARED_LOCK のいずれか、または両方です。
説明

Cache LOCK コマンドを実行して、指定したロック名のロック・カウントをデクリメントします。このコマンドは、一度に 1 つずつ増分ロックを解放するだけです。

CacheReleaseLock の返り値

CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_SUCCESS ロックに成功しました。

CacheSecureStartA

バリアント : CacheSecureStartWCacheSecureStartH

int CacheSecureStartA(CACHE_ASTRP username, CACHE_ASTRP password, CACHE_ASTRP exename, 
                      unsigned long flags, int tout, CACHE_ASTRP prinp, CACHE_ASTRP prout)
引数

username 認証するユーザ名です。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
password 認証するパスワードです。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
exename コールイン実行可能プログラム名 (または他のプロセス識別子です)。このユーザ定義文字列は、JOBEXAM および監査記録に表示されます。NULL は有効な値です。
flags 1 つまたは複数のターミナル設定を以下に示します。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Cache プロセスをセットアップするために、Cache を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheSecureStartA の返り値

CACHE_ACCESSDENIED 認証が失敗しました。実際の認証エラーについて、監査ログを確認してください。
CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheSecureStartH を呼び出した場合に返されます。
CACHE_CHANGEPASSWORD パスワードの変更が必要です。この返り値は、Caché 認証を使用している場合にのみ返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEnd は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

CacheSecureStartH

バリアント : CacheSecureStartACacheSecureStartW

int CacheSecureStartH(CACHEHSTRP username, CACHEHSTRP password, CACHEHSTRP exename, 
                      unsigned long flags, int tout, CACHEHSTRP prinp, CACHEHSTRP prout)
引数

username 認証するユーザ名です。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
password 認証するパスワードです。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
exename コールイン実行可能プログラム名 (または他のプロセス識別子です)。このユーザ定義文字列は、JOBEXAM および監査記録に表示されます。NULL は有効な値です。
flags 1 つまたは複数のターミナル設定を以下に示します。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Cache プロセスをセットアップするために、Cache を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheSecureStartH の返り値

CACHE_ACCESSDENIED 認証が失敗しました。実際の認証エラーについて、監査ログを確認してください。
CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheSecureStartH を呼び出した場合に返されます。
CACHE_CHANGEPASSWORD パスワードの変更が必要です。この返り値は、Caché 認証を使用している場合にのみ返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEnd は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

CacheSecureStartW

バリアント : CacheSecureStartACacheSecureStartH

int CacheSecureStartW(CACHEWSTRP username, CACHEWSTRP password, CACHEWSTRP exename, 
                      unsigned long flags, int tout, CACHEWSTRP prinp, CACHEWSTRP prout)
引数

username 認証するユーザ名です。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
password 認証するパスワードです。UnknownUser 認証または OS 認証として認証するには NULL を使用し、それ以外の場合は Kerberos 資格情報キャッシュの情報を使用します。
exename コールイン実行可能プログラム名 (または他のプロセス識別子です)。このユーザ定義文字列は、JOBEXAM および監査記録に表示されます。NULL は有効な値です。
flags 1 つまたは複数のターミナル設定を以下に示します。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Cache プロセスをセットアップするために、Cache を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheSecureStartW の返り値

CACHE_ACCESSDENIED 認証が失敗しました。実際の認証エラーについて、監査ログを確認してください。
CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheSecureStartH を呼び出した場合に返されます。
CACHE_CHANGEPASSWORD パスワードの変更が必要です。この返り値は、Caché 認証を使用している場合にのみ返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEnd は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

CacheSetDir

int CacheSetDir(char * dir)
引数

dir ディレクトリ名文字列へのポインタ。
説明

実行時に、マネージャのディレクトリ (CacheSys\Mgr) の名前を動的に設定します。Windows では、Caché の共有ライブラリ・バージョンで、インストールのマネージャ・ディレクトリを識別するためにこの関数を使用する必要があります。

CacheSetDir の返り値

CACHE_FAILURE (コールイン実行可能プログラムの内部からではなく) $ZF 関数から呼び出された場合に返されます。
CACHE_SUCCESS 制御関数が実行されました。

CacheSetProperty

int CacheSetProperty( )
説明

CachePushProperty により定義されたプロパティの値を格納します。この呼び出しを行う前に、値を引数スタックにプッシュしておく必要があります。

CacheSetProperty の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_SUCCESS 操作は正常に終了しました。

CacheSignal

int CacheSignal(int signal)
引数

signal オペレーティング・システムの信号値です。
説明

ユーザ・プログラムにより補足された信号を Caché に渡します。

この関数は、CacheAbort に非常によく似ていますが、適切と思われる任意のアクションに対して、接続のスレッドまたはユーザ側から、Caché 側に、任意の既知の信号値を渡すことができます。例えば、Caché に対するユーザ定義の信号ハンドラで傍受された信号を渡すために使用できます。

Note:

Cache の VMS バージョンでは、信号処理を使用しません。VMS と Unix® の両方で使用できるようにコンパイルされたプログラムが、信号処理上のこの相違の影響を受けないように、VMS システムでは CacheSignal は CACHE_SUCCESS を返します。

rc = CacheSignal(CTRL_C_EVENT); // Windows response to Ctrl-C
rc = CacheSignal(CTRL_C_EVENT); // UNIX response to Ctrl-C
CacheSignal の返り値

CACHE_CONBROKEN 接続は切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_NOTINCACHE 現在コールイン・パートナーが Caché に存在しません。
CACHE_SUCCESS 接続が確立されました。

CacheSPCReceive

int CacheSPCReceive(int * lenp, Callin_char_t * ptr)
引数

lenp 受信する最大長です。返されるときに、実際に受信されたバイト数を示すように修正されます。
ptr メッセージを受信するバッファへのポインタです。lenp バイト以上にする必要があります。
説明

シングル・プロセス通信メッセージを受信します。現在のデバイスは、SPC モードで開かれた TCP でなければなりません。そうでない場合、CACHE_ERFUNCTION が返されます。

CacheSPCReceive の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERFUNCTION 現在のデバイスが TCP デバイスでないか、接続されていません。
CACHE_SUCCESS 操作は正常に終了しました。

CacheSPCSend

int CacheSPCSend(int len, const Callin_char_t * ptr)
引数

len メッセージの長さ (単位はバイト)
ptr メッセージを含む文字列へのポインタ。
説明

シングル・プロセス通信メッセージを送信します。現在のデバイスは、SPC モードで開かれた TCP でなければなりません。そうでない場合、CACHE_ERFUNCTION が返されます。

CacheSPCSend の返り値

CACHE_CONBROKEN 接続は、深刻なエラーによって切断されました。
CACHE_NOCON 接続が確立されていません。
CACHE_ERSYSTEM Caché エンジンが <SYSTEM> エラーを生成した、またはコールインが内部データの不整合を検出しました。
CACHE_ERFUNCTION 現在のデバイスが TCP デバイスでないか、接続されていません。
CACHE_ERARGSTACK 引数スタックがオーバーフローしています。
CACHE_ERSTRINGSTACK 文字列スタックがオーバーフローしています。
CACHE_SUCCESS 操作は正常に終了しました。
任意の Caché のエラー 名前の変換によります。

CacheStartA

バリアント : CacheStartWCacheStartH

int CacheStartA(unsigned long flags, int tout, CACHE_ASTRP prinp, CACHE_ASTRP prout)
引数

flags 以下に説明する値の 1 つまたは複数を取ります。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Caché プロセスをセットアップするために、Caché を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheStartA の返り値

CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheStartA を呼び出した場合に返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEndA は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

Caché プロセスが開始されました。ターミナルは、各インタフェースのコールイン関数の後にリセットされます。20 秒以内にパーティションが割り当てられない場合、起動は失敗します。ファイル dobackup は、入力用に使用します。このファイルには、Caché バックアップ用の ObjectScript スクリプトが含まれます。出力は、ターミナルに表示されます。

CACHE_ASTR inpdev;
CACHE_ASTR outdev;
int rc;

strcpy(inpdev.str, "[BATCHDIR]dobackup");
inpdev.len = strlen(inpdev.str);
strcpy(outdev.str,"");
outdev.len = strlen(outdev.str);
rc = CacheStartA(CACHE_TTALL|CACHE_TTNOUSE,0,inpdev,outdev);

CacheStartH

バリアント : CacheStartACacheStartW

int CacheStartH(unsigned long flags,int tout,CACHEHSTRP prinp,CACHEHSTRP prout)
引数

flags 以下に説明する値の 1 つまたは複数を取ります。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Caché プロセスをセットアップするために、Caché を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheStartH の返り値

CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheStartH を呼び出した場合に返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEndH は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

Caché プロセスが開始されました。ターミナルは、各インタフェースのコールイン関数の後にリセットされます。20 秒以内にパーティションが割り当てられない場合、起動は失敗します。ファイル dobackup は、入力用に使用します。このファイルには、Caché バックアップ用の ObjectScript スクリプトが含まれます。出力は、ターミナルに表示されます。

inpdev;
outdev;
int rc;

strcpy(inpdev.str, "[BATCHDIR]dobackup");
inpdev.len = strlen(inpdev.str);
strcpy(outdev.str,"");
outdev.len = strlen(outdev.str);
rc = CacheStartH(CACHE_TTALL|CACHE_TTNOUSE,0,inpdev,outdev);

CacheStartW

バリアント : CacheStartACacheStartH

int CacheStartW(unsigned long flags,int tout,CACHEWSTRP prinp,CACHEWSTRP prout)
引数

flags 以下に説明する値の 1 つまたは複数を取ります。
tout 秒単位で指定されたタイムアウト値です。既定値は 0 です。0 を指定すると、タイムアウトにはなりません。タイムアウトは、パーティションが使用可能になるまで待機する場合にのみ適用されます。パーティションの初期化、内部リソースの待機、主入出力デバイスを開く処理などには適用されません。
prinp Caché の主入力デバイスを定義する文字列です。空の文字列 (prinp.len == 0) はプロセスの標準入力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
prout Caché の主出力デバイスを定義する文字列です。空の文字列 (prout.len == 0) はプロセスの標準出力デバイスの使用を意味しています。NULL ポインタ ((void *) 0) は NULL デバイスの使用を意味しています。
説明

Caché プロセスをセットアップするために、Caché を呼び出します。

このコマンドを実行すると、最初の入出力操作を待たずに、入力デバイス (prinp)、および出力デバイス (prout) が開きます。これに対し、通常、キャッシュ・コマンドで Caché 接続を開始した場合は、主入力または主出力デバイスが最初に使用されるまでデバイスは開きません。

flags 変数の有効な値は以下のとおりです。

  • CACHE_PROGMODE — Caché により、接続は、アプリケーション・モードではなく、プログラマ・モードの接続として扱われます。つまり、呼び出し側関数に対して明確なエラーが報告され、接続は有効なままになります(既定では、コールイン接続は、アプリケーション・モードでのルーチンの実行のようなものです。Caché により実行時のエラーが検知されると、接続が閉じられ、現在の操作に対してエラー CACHE_CONBROKEN が返されるだけでなく、それ以降に、新しい接続を確立せずにコールインを使用しようとしても、同じエラーが返されます)。

  • CACHE_TTALL — 既定値。Caché はターミナルの設定を初期化し、インタフェースを呼び出して戻るたびに、その設定をリストアする必要があります。

  • CACHE_TTCALLIN — Caché は、ターミナルが呼び出されるたびにそのターミナルを初期化しますが、ターミナルのリストアは CacheEnd が呼び出されたときまたは接続が切断されたときにのみ実行します。

  • CACHE_TTSTART — Caché は、接続の形成時にターミナルを初期化し、切断時にターミナルをリセットする必要があります。

  • CACHE_TTNEVER — Caché は、ターミナルの設定を変更すべきではありません。

  • CACHE_TTNONE — Caché は、主入出力デバイスからの入出力はできません。これは主入力、および主出力に対して NULL デバイスを指定することと同等です。主入力からの Read コマンドは <ENDOFFILE> エラーを生成し、主出力への Write コマンドは無視されます。

  • CACHE_TTNOUSE — このフラグは、CACHE_TTALL、CACHE_TTCALLIN、CACHE_TTSTART で使用可能で、CACHE_TTNEVER と CACHE_TTNONE フラグにより暗黙的に設定されます。最初に主入力と主出力を開いた後は、Caché の Open コマンドと Use コマンドを使用してもターミナルは変更できなくなります。

CacheStartW の返り値

CACHE_ALREADYCON 既に接続されています。$ZF 関数から CacheStartW を呼び出した場合に返されます。
CACHE_CONBROKEN 接続が確立され、その後切断されました。また、CacheEndW は、削除するために呼び出されませんでした。
CACHE_FAILURE 予期しないエラーが発生しました。
CACHE_STRTOOLONG prinp または prout が長すぎます。
CACHE_SUCCESS 接続が確立されました。

フラグ・パラメータは、C プログラムの振る舞いと、Caché ターミナル属性の設定方法を通知します。時間はかかりますが最も安全な方法は、ObjectScript の呼び出しごとに Caché からターミナルを設定し、その設定をリストアすることです。ただし、ユーザ自身が設定を処理し、プログラムに関連する情報のみ収集すれば、ObjectScript のオーバーヘッドを軽減できます。パラメータ CACHE_TTNEVER により、オーバーヘッドを最小限にできます。

Caché プロセスが開始されました。ターミナルは、各インタフェースのコールイン関数の後にリセットされます。20 秒以内にパーティションが割り当てられない場合、起動は失敗します。ファイル dobackup は、入力用に使用します。このファイルには、Caché バックアップ用の ObjectScript スクリプトが含まれます。出力は、ターミナルに表示されます。

inpdev;
outdev;
int rc;

strcpy(inpdev.str, "[BATCHDIR]dobackup");
inpdev.len = strlen(inpdev.str);
strcpy(outdev.str,"");
outdev.len = strlen(outdev.str);
rc = CacheStartW(CACHE_TTALL|CACHE_TTNOUSE,0,inpdev,outdev);

CacheTCommit

int CacheTCommit( )
説明

Cache TCommit コマンドを実行します。

CacheTCommit の返り値

CACHE_SUCCESS TCommit は正常に終了しました。

CacheTLevel

int CacheTLevel( )
説明

トランザクション処理に対する、現在の入れ子レベル ($TLEVEL) を返します。

CacheTLevel の返り値

CACHE_SUCCESS TLevel は正常に終了しました。

CacheTRollback

int CacheTRollback(int nlev)
引数

nlev ロールバックするレベル数を決定します (0 の場合はすべてのレベル、1 の場合は 1 つのレベル)。
説明

Cache TRollback コマンドを実行します。nlev が 0 の場合、TSTART が発行されているレベル数に関係なく、処理中のすべてのトランザクションをロールバックし、$TLEVEL を 0 にリセットします。nlev が 1 の場合、入れ子になったトランザクションの現在のレベル (最新の TSTART によって開始されたレベル) をロールバックし、$TLEVEL を 1 デクリメントします。

CacheTRollback の返り値

CACHE_SUCCESS TStart は正常に終了しました。

CacheTStart

int CacheTStart( )
説明

Cache TStart コマンドを実行します。

CacheTStart の返り値

CACHE_SUCCESS TStart は正常に終了しました。

CacheType

int CacheType( )
説明

CacheEvalACacheEvalW、または CacheEvalH により、関数値として返される項目のネイティブ・タイプを返します。

CacheType の返り値

CACHE_ASTRING 8 ビットの文字列。
CACHE_CONBROKEN 接続は、深刻なエラー状態、または RESJOB によって切断されました。
CACHE_DOUBLE Caché の 64 ビットの浮動小数点。
CACHE_ERSYSTEM ObjectScript が <SYSTEM> エラーを生成した場合または $ZF 関数から呼び出された場合は、内部カウンタが同期していない可能性があります。
CACHE_IEEE_DBL IEEE の 64 ビットの浮動小数点。
CACHE_INT 32 ビットの整数。
CACHE_NOCON 接続が確立されていません。
CACHE_NORES 返すことができるタイプを持つ結果がありません (この呼び出しの前に、CacheEvalA または CacheEvalW が呼び出されていません)。
CACHE_OREF Caché オブジェクト参照
CACHE_WSTRING Unicode 文字列。

rc = CacheType();

CacheUnPop

int CacheUnPop( )
説明

CachePop からスタック・エントリをリストアします。

CacheUnPop の返り値

CACHE_NORES 返すことができるタイプを持つ結果が、この呼び出しの前にありません。
CACHE_SUCCESS 操作は正常に終了しました。
FeedbackOpens in a new tab