OCI XML DB関数

この項では、XML DB関数について説明します。

表23-3 XML DB関数

関数	用途
OCIBinXmlCreateReposCtxFromConn()	メタデータ接続コンテキストを作成します。
OCIBinXmlCreateReposCtxFromCPool()	メタデータ接続コンテキストの接続プールを作成します。
OCIBinXmlSetReposCtxForConn()	データ接続をメタデータ接続に関連付けます。
OCIBinXmlSetFormatPref()	転送されるイメージがバイナリのXMLフォーマットであることを指定します。
OCIXmlDbFreeXmlCtx()	XMLコンテキストを解放します。
OCIXmlDbInitXmlCtx()	データベースからのXMLデータのXMLコンテキストを初期化します。

OCIBinXmlCreateReposCtxFromConn()

用途

指定のOCIEnv/OCISvcCtx専用OCI接続からメタデータ接続コンテキスト（OCIBinXmlReposCtx）を作成します。この接続はメタデータ専用であることに注意してください。

構文

sword OCIBinXmlCreateReposCtxFromConn (   OCIEnv             *env,                                           OCISvcCtx          *svcctx,
                                          OCIError           *err,
                                          OCIBinXmlReposCtx  **ctx);

パラメータ

env (IN): 環境ハンドルです。

svcctx (IN): メタデータへのアクセスに使用する接続へのハンドルです。

err (IN): エラー・ハンドルです。

ctx (OUT): 作成され戻されるメタデータ・コンテキストです。

エラーの場合は-1、成功の場合は0（ゼロ）が戻されます。errには、エラーの詳細情報が含まれます。

関連関数

OCIBinXmlCreateReposCtxFromCPool()

用途

指定の接続プールからメタデータ接続コンテキスト（OCIBinXmlReposCtx）を作成します。トークン・リポジトリからの情報が必要になるたびに、接続プール内の接続が使用されます。

構文

sword OCIBinXmlCreateReposCtxFromCPool (   OCIEnv             *env,                                            OCICPool           *cpool,
                                           OCIError           *err,
                                           OCIBinXmlReposCtx  **ctx);

パラメータ

env (IN): 環境ハンドルです。

svcctx (IN): メタデータへのアクセスに使用する接続へのハンドルです。

err (IN): エラー・ハンドルです。

ctx (OUT): 作成され戻されるメタデータ・コンテキストです。

エラーの場合は-1、成功の場合は0（ゼロ）が戻されます。errには、エラーの詳細情報が含まれます。

関連関数

OCIBinXmlCreateReposCtxFromConn()

OCIBinXmlSetReposCtxForConn()

用途

データ接続をメタデータ接続に関連付けます。専用接続の場合、データ接続とメタデータ接続の環境ハンドルが同一である必要があることに注意してください。

構文

sword OCIBinXmlSetReposCtxForConn (   OCISvcCtx          *dataconn,
                                      OCIBinXmlReposCtx  *reposctx);

パラメータ

dataconn (IN): データ接続ハンドルです。

reposctx (IN): メタデータ接続へのポインタです。

エラーの場合は-1、成功の場合は0（ゼロ）が戻されます。errには、エラーの詳細情報が含まれます。

関連関数

OCIBinXmlSetFormatPref()

用途

XML文書についてクライアントとサーバーの間で転送されるイメージが、バイナリのXMLフォーマットであることを指定します。将来は、すべての通信にバイナリのXMLフォーマットが使用されます。現在、このフォーマットを設定できるのは、バイナリXML対応アプリケーションのみです。

構文

sword OCIBinXmlSetFormatPref (   xmldomdoc   *doc,
                                 ub4         formattype);

パラメータ

doc (IN): プリファレンスの適用対象であるdomdocへのポインタです。

formattype (IN): ピクルに使用するフォーマットのタイプです。現在、使用可能な値はOCI_PICKLE_TYPE_BINXMLおよびOCI_PICKLE_TYPE_TEXTのみです。

エラーの場合は-1、成功の場合は0（ゼロ）が戻されます。

関連関数

OCIBinXmlSetReposCtxForConn()

OCIXmlDbFreeXmlCtx()

用途

OCIXmlDbInitXmlCtx()へのコールによる割当てを解放します。

構文

void OCIXmlDbFreeXmlCtx ( xmlct   *xctx );

パラメータ

xctx (IN): 終了するXMLコンテキストです。

エラーの場合は-1、成功の場合は0（ゼロ）が戻されます。

関連関数

OCIXmlDbInitXmlCtx()

用途

データベースからのXMLデータのXMLコンテキストを初期化します。

構文

xmlctx *OCIXmlDbInitXmlCtx (   OCIEnv                *envhp,
                               OCISvcCtx             *svchp,
                               OCIError              *errhp,
                               ocixmldbparam         *params,
                               ub4                   num_params );

パラメータ

envhp (IN)

OCI環境ハンドルです。

svchp (IN)

OCIサービス・ハンドルです。

errhp (IN)

OCIエラー・ハンドルです。

params (IN)

オプションで使用可能なこの配列の値は、次に対するポインタです。

OCIの継続時間。デフォルト値はOCI_DURATION_SESSIONです。

次のプロトタイプのユーザー登録コールバックであるエラー・ハンドラ。

void (*err_handler) (sword errcode, (const OraText *) errmsg);

err_handlerの2つのパラメータは次のとおりです。

errcode (OUT)

数値のエラー値です。

errmsg (OUT)

エラー・メッセージ・テキストです。

num_params (IN)

paramsから読み取られるパラメータ数です。num_paramsの値が配列paramsのサイズより大きい場合、予期しない結果が発生します。

関連関数

OCIXmlDbFreeXmlCtx()