cniSqlCreateModifyablePathExpression

path 引数により指定されたパスを表す、修正可能な SqlPathExpression オブジェクトを作成します。 修正可能とは、ナビゲートの際、パスのエレメントがまだ存在していないとしても、これが作成されるということを意味します。 この関数は、PathExpression オブジェクトへのポインターを戻します。これは、パスをナビゲートする関数、すなわち cniSqlNavigatePath ファミリーへの入力として使用されます。式の作成にはオーバーヘッドが伴うため、すべてのメッセージに同じパス式が使用される場合には、この関数を 1 回呼び出し、戻された CciSqlPathExpression* を使用して、cniSqlNavigate をそれぞれのメッセージごとに呼び出すようにします。 CciSqlPathExpression は、作成元のスレッドとは異なるスレッドでも使用可能です。

構文

CciSqlPathExpression* cniSqlCreateModifiablePathExpression(
int* returnCode,
CciNode* nodeObject,
CciChar* dataSourceName,
CciChar* path);

パラメーター

returnCode (出力)
NULL ポインターを入力すると、ユーザー定義ノードがエラーを処理しないことを示します。この呼び出しの実行時にスローされた例外は、フロー内の次のアップストリーム・ノードに対して再度スローされます。 入力が NULL でない場合、出力は呼び出しの成功状況を示します。 実行時に例外が発生する場合、出力時に *returnCode が CCI_EXCEPTION に設定されます。 cciGetLastExceptionData を呼び出すと、例外の詳細が提供されます。 無効な nodeObject パラメーターが渡された場合、returnCode は CCI_INV_NODE_OBJECT に設定されます。NULL や空ストリングなどの無効な path パラメーターが渡された場合、returnCode は CCI_INV_ESQL_PATH_EXPR に設定されます。
nodeObject (入力)
ESQL パス式を所有するメッセージ・フロー処理ノードを指定します。 このポインターは、cniCreateNodeContext インプリメンテーション関数に渡されます。このパラメーターは NULL にはできません。
dataSourceName (入力)
ステートメントが外部データベースを参照する場合に使用される ODBC データ・ソース名。 このパラメーターは NULL に設定可能です。
path (入力)
CciChar の NULL 終了ストリングへのポインター。これは、ESQL フィールド参照構文図の定義に従って作成されることになる ESQL パス式を指定します。ただし、ESQL 変数、ESQL 参照変数、ユーザー定義関数、ESQL 名前空間定数は宣言できないため、含めることができません。 このパラメーターは NULL にはできません。

戻り値

成功した場合、SQLPathExpression オブジェクトのアドレスが戻されます。 エラーが発生した場合、CCI_NULL_ADDR が戻され、戻りコード・パラメーターがエラーの理由を示します。 SQLPathExpression が不要になったら (通常はノードが削除されるとき)、cniSqlDeletePathExpression を呼び出してそれを削除する必要があります。

以下のコードを Transform ノード・サンプルに追加することにより、1 回の関数呼び出しで、エレメントと必要な上位エレメントすべてを容易に作成することができます。

以下のようにして、CciSQLPathExpression を _Transform_createNodeContext 関数で作成します。

 {
        CciChar ucsPathExpressionString[32];
        char* mbPathExpressionString =
                           "OutputRoot.XML.Request.A.B.C.D.E";
        /* convert our path string to unicode*/
        cciMbsToUcs(NULL,
            mbPathExpressionString,
            ucsPathExpressionString,
            32,
            BIP_DEF_COMP_CCSID);
        
        p->pathExpression =
                     cniSqlCreateModifiablePathExpression(
                                 NULL,
                                 nodeObject,
                                 NULL,/*we do not reference Database*/
                                 ucsPathExpressionString);
    }

その後、この CciSqlPathExpression を、以下のように後で _Transform_evaluate 関数内で使用することができます。

{
      CciElement* newElement =
               cniSqlNavigatePath(
                     NULL,
                    ((NODE_CONTEXT_ST *)context)->pathExpression,
                     message,
                     destinationList,
                     exceptionList,
                     outMsg,
                     NULL,/*we do not reference OutputLocalEnvironment*/
                     NULL/*we do not reference OutputLExceptionList*/);
}

ここで、以下の入力メッセージ PluginSample.change.xml を渡します。

<Request
type="change">
  <CustomerAccount>01234567</CustomerAccount>
  <CustomerPhone>555-0000</CustomerPhone>
</Request>

そうすると、次の出力メッセージが得られます。

<Request
type="modify">
  <CustomerAccount>01234567</CustomerAccount>
  <CustomerPhone>555-0000</CustomerPhone>
  <A>
    <B>
      	<C>
        <D/>
      	</C>
    </B>
  </A>
</Request>
cniCreateElementAsLastChild などを使うことと比べて、このアプローチを使うことには次のような利点があります。
  • パスが一層動的なものになります。例えばノード属性を基に、パス・ストリングをデプロイ時に決定できるかもしれません (CciSQLPathExpressioncniSetAttribute インプリメンテーション関数に作成できるかもしれません)。
  • エレメントへのナビゲートおよび作成中、何度も関数呼び出しを行わずに、1 回で済ませることができます。 ターゲット・エレメントがツリー構造の下位にある場合、違いがよりよくわかります。
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック
Copyright IBM Corporation 1999, 2006 最終更新: 08/21/2006
as08032_