ユーザー・メッセージAPIは、カートリッジ開発者が、独自のメッセージおよびOracle Databaseメッセージを取得するための単純なインタフェースを提供します。
関連項目: 『Oracle Databaseデータ・カートリッジ開発者ガイド』 |
表22-7は、この項で説明しているOCIメッセージ関数を示しています。
表22-7 OCIメッセージ関数
関数 | 用途 |
---|---|
|
メッセージ・ハンドルをクローズし、ハンドルに関連するすべてのメモリーを解放します。 |
|
メッセージを取り出します。バッファが0 (ゼロ)でない場合、この関数は、バッファにメッセージをコピーします。 |
|
指定された言語でメッセージ・ハンドルをオープンします。 |
パラメータ
メッセージ言語のOCI環境ハンドルまたはユーザー・セッション・ハンドルへのポインタです。
OCIエラー・ハンドルです。エラーがある場合は、errhp
に記録され、NULL
ポインタが戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
OCIMessageOpen()によってすでにオープンされているメッセージ・ハンドルへのポインタです。
パラメータ
OCIMessageOpen()によってすでにオープンされているメッセージ・ハンドルへのポインタです。
メッセージ番号です。
取り出したメッセージの宛先バッファへのポインタです。buflen
が0 (ゼロ)の場合、NULL
ポインタを使用できます。
宛先バッファのサイズです。
構文
sword OCIMessageOpen ( void *hndl, OCIError *errhp, OCIMsg *msghp, const OraText *product, const OraText *facility, OCIDuration dur );
パラメータ
メッセージ言語のOCI環境ハンドルまたはユーザー・セッション・ハンドルへのポインタです。
OCIエラー・ハンドルです。エラーがある場合は、errhp
に記録され、NULL
ポインタが戻されます。OCIErrorGet()のコールによって診断情報を取得できます。
戻りのためのメッセージ・ハンドルです。
製品名へのポインタです。製品名は、メッセージのディレクトリを検出するために使用されます。位置は、オペレーティング・システムによって異なります。たとえば、Solarisの場合、rdbms
製品のメッセージ・ファイルのディレクトリは$ORACLE_HOME/rdbms
です。
製品の機能名へのポインタです。メッセージ・ファイル名を構成するのに使用されます。メッセージ・ファイル名は、接頭辞としてfacility
名が付く変換に従います。たとえば、英語のimg
機能のメッセージ・ファイル名はimgus.msb
です。ここで、us
は英語の略語で、msb
はメッセージ・バイナリ・ファイルの拡張子です。
戻りメッセージ・ハンドルのメモリー割当ての継続期間です。次のいずれかの値です。
OCI_DURATION_PROCESS
OCI_DURATION_SESSION
OCI_DURATION_STATEMENT