WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

Destination

宛先は、アプリケーションが送信するメッセージの送信先であるか、アプリケーションが受け取るメッセージの送信元であるか、またはその両方です。

Destination オブジェクトの XMS 定義プロパティーのリストについては、Destination のプロパティーを参照してください。

関連概念
接続ファクトリーおよび接続
WebSphere サービス統合バスへの接続
宛先
トピック URI
キュー URI
一時宛先
関連タスク
管理対象オブジェクトの作成

関数

関数の要約:
関数 説明
xmsDestCreate 指定された URI (Uniform Resource Identifier) を使用して、宛先を作成します。
xmsDestCreateByType 指定された宛先タイプおよび名前を使用して、宛先を作成します。
xmsDestCreateTemporaryByType 一時宛先を作成します。
xmsDestDispose 宛先を削除します。
xmsDestGetName 宛先名を取得します。
xmsDestGetTypeId 宛先のタイプを取得します。
xmsDestToString 宛先の名前を、URI (Uniform Resource Identifier) の形式で取得します。

xmsDestCreate – 宛先の作成 (URI を使用)

インターフェース:
xmsRC xmsDestCreate(xmsCHAR *URI,
xmsHDest *destination,
xmsHErrorBlock errorBlock);

指定された URI (Uniform Resource Identifier) を使用して、宛先を作成します。URI によって指定されなかった宛先のプロパティーは、デフォルト値を使用します。

宛先がキューである場合、この関数は、メッセージング・サーバーにキューを作成しません。アプリケーションがこの関数を呼び出すためには、その前にキューを作成する必要があります。

パラメーター:
URI (入力)
ヌル終了ストリング形式の URI。
destination (出力)
宛先のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestCreateByType – 宛先の作成 (タイプおよび名前を指定)

インターフェース:
xmsRC xmsDestCreateByType(xmsDESTINATION_TYPE destinationType,
xmsCHAR *destinationName,
xmsHDest *destination,
xmsHErrorBlock errorBlock);

指定された宛先タイプおよび名前を使用して、宛先を作成します。

宛先がキューである場合、この関数は、メッセージング・サーバーにキューを作成しません。アプリケーションがこの関数を呼び出すためには、その前にキューを作成する必要があります。

パラメーター:
destinationType (入力)
宛先のタイプ。以下の値のいずれかでなければなりません。
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
destinationName (入力)
宛先の名前。キューの名前またはトピックの名前を指定できます。名前はヌル終了ストリング形式です。
宛先が WebSphere MQ キューである場合、以下のいずれかの方法で宛先の名前を指定することができます。
  • QName
  • QMgrName/QName
ここで、QNameWebSphere MQ キューの名前、QMgrNameWebSphere MQ キュー・マネージャーの名前です。 WebSphere MQ キュー名解決プロセスでは、QName および QMgrName の値を使用して、実際の宛先キューを判別します。キュー名解決プロセスについて詳しくは、「WebSphere MQ アプリケーション・プログラミング・ガイド」を参照してください。
destination (出力)
宛先のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestCreateTemporaryByType – 一時宛先の作成

インターフェース:
xmsRC xmsDestCreateTemporaryByType(xmsDESTINATION_TYPE destinationType,
xmsHSess session,
xmsHDest *destination,
xmsHErrorBlock errorBlock);

一時宛先を作成します。

一時宛先のスコープは接続です。接続によって作成されたセッションのみが、一時宛先を使用できます。

一時宛先は、明示的に削除されるまで、あるいは接続が終了するまで存続します。

一時宛先について詳しくは、一時宛先を参照してください。

パラメーター:
destinationType (入力)
一時宛先のタイプ。以下の値のいずれかでなければなりません。
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
session (入力)
セッションのハンドル。
destination (出力)
一時宛先のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestDispose – 宛先の削除

インターフェース:
xmsRC xmsDestDispose(xmsHDest *destination,
xmsHErrorBlock errorBlock);

宛先を削除します。

宛先がキューである場合、そのキューが XMS 一時キューとして作成されていない限り、この関数はメッセージング・サーバー内のキューを削除しません。

アプリケーションが、既に削除されている宛先を削除しようとした場合、呼び出しは無視されます。

パラメーター:
destination (入出力)
入力では、宛先のハンドル。出力で、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestGetName – 宛先名の取得

インターフェース:
xmsRC xmsDestGetName(xmsHDest destination,
xmsCHAR *destinationName,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

宛先名を取得します。

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
destination (入力)
宛先のハンドル。
destinationName (出力)
宛先名を含むバッファー。名前は、キューの名前またはトピックの名前のいずれかです。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、宛先名は戻されませんが、actualLength パラメーターで宛先名の長さが戻されます。
actualLength (出力)
宛先名の長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestGetTypeId – 宛先タイプの取得

インターフェース:
xmsRC xmsDestGetTypeId(xmsHDest destination,
xmsDESTINATION_TYPE *destinationType,
xmsHErrorBlock errorBlock);

宛先のタイプを取得します。

パラメーター:
destination (入力)
宛先のハンドル。
destinationType (出力)
宛先のタイプ。以下の値のいずれかです。
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsDestToString – 宛先名を URI として取得

インターフェース:
xmsRC xmsDestToString(xmsHDest destination,
xmsCHAR *destinationName,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

宛先の名前を、URI (Uniform Resource Identifier) の形式で取得します。

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
destination (入力)
宛先のハンドル。
destinationName (出力)
URI を含むバッファー。URI は、キュー URI またはトピック URI です。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、URI は戻されませんが、actualLength パラメーターで URI の長さが戻されます。
actualLength (出力)
URI の長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)