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

Message

Message オブジェクトは、アプリケーションが送信または受信するメッセージを表します。

Message オブジェクトの JMS メッセージ・ヘッダー・フィールドのリストについては、XMS メッセージのヘッダー・フィールドを参照してください。 Message オブジェクトの JMS 定義プロパティーのリストについては、メッセージの JMS 定義プロパティーを参照してください。Message オブジェクトの IBM 定義プロパティーのリストについては、メッセージの IBM 定義プロパティーを参照してください。

関連資料
XMS メッセージ

関数

関数の要約:
関数 説明
xmsMsgAcknowledge このメッセージと、セッションが以前に受信して、まだ応答していないすべてのメッセージに応答します。
xmsMsgClearBody メッセージの本体をクリアします。
xmsMsgClearProperties メッセージのプロパティーをクリアします。
xmsMsgDispose メッセージを削除します。
xmsMsgGetJMSCorrelationID メッセージの相関 ID を取得します。
xmsMsgGetJMSDeliveryMode メッセージの送達モードを取得します。
xmsMsgGetJMSDestination メッセージ宛先を取得します。
xmsMsgGetJMSExpiration メッセージの有効期限切れ時刻を取得します。
xmsMsgGetJMSMessageID メッセージのメッセージ ID を取得します。
xmsMsgGetJMSPriority メッセージの優先順位を取得します。
xmsMsgGetJMSRedelivered メッセージが再配信されるかどうかの標識を取得します。
xmsMsgGetJMSReplyTo メッセージに対する応答が送信される宛先を取得します。
xmsMsgGetJMSTimestamp メッセージが送信された時刻を取得します。
xmsMsgGetJMSType メッセージのタイプを取得します。
xmsMsgGetProperties メッセージのプロパティーのリストを取得します。
xmsMsgGetTypeId メッセージの本体タイプを取得します。
xmsMsgPropertyExists メッセージに、指定された名前のプロパティーがあるかどうかを検査します。
xmsMsgSetJMSCorrelationID メッセージの相関 ID を設定します。
xmsMsgSetJMSDeliveryMode メッセージの送達モードを設定します。
xmsMsgSetJMSDestination メッセージ宛先を設定します。
xmsMsgSetJMSExpiration メッセージの有効期限切れ時刻を設定します。
xmsMsgSetJMSMessageID メッセージのメッセージ ID を設定します。
xmsMsgSetJMSPriority メッセージの優先順位を設定します。
xmsMsgSetJMSRedelivered メッセージが再配信されるかどうかを示します。
xmsMsgSetJMSReplyTo メッセージに対する応答が送信される宛先を設定します。
xmsMsgSetJMSTimestamp メッセージが送信される時刻を設定します。
xmsMsgSetJMSType メッセージのタイプを設定します。

xmsMsgAcknowledge – 応答

インターフェース:
xmsRC xmsMsgAcknowledge(xmsHMsg message,
xmsHErrorBlock errorBlock);

このメッセージと、セッションが以前に受信して、まだ応答していないすべてのメッセージに応答します。

セッションの応答モードが XMSC_CLIENT_ACKNOWLEDGE である場合、アプリケーションはこの関数を呼び出すことができます。セッションがその他の応答モードであるか、セッションが処理中である場合は、この関数の呼び出しは無視されます。

受信されたが、応答されていないメッセージは、再配信される可能性があります。

メッセージの応答について詳しくは、セッションでのメッセージの受信の確認を参照してください。

パラメーター:
message (入力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

xmsMsgClearBody – 本体のクリア

インターフェース:
xmsRC xmsMsgClearBody(xmsHMsg message,
xmsHErrorBlock errorBlock);

メッセージの本体をクリアします。ヘッダー・フィールドおよびメッセージ・プロパティーはクリアされません。

アプリケーションがメッセージ本体をクリアすると、本体は、新規に作成されたメッセージ内の空の本体と同じ状態になります。新規に作成されたメッセージ内の空の本体の状態は、メッセージ本体のタイプによって異なります。詳しくは、XMS メッセージの本文を参照してください。

アプリケーションは、本体の状態にかかわらず、いつでもメッセージ本体をクリアできます。 メッセージ本体が読み取り専用の場合、アプリケーションが本体に書き込むことができる唯一の方法は、まずアプリケーションが本体をクリアすることです。

パラメーター:
message (入力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgClearProperties – プロパティーのクリア

インターフェース:
xmsRC xmsMsgClearProperties(xmsHMsg message,
xmsHErrorBlock errorBlock);

メッセージのプロパティーをクリアします。ヘッダー・フィールドおよびメッセージ本体はクリアされません。

アプリケーションがメッセージのプロパティーをクリアした場合、プロパティーは読み書き可能になります。

アプリケーションは、プロパティーの状態にかかわらず、いつでもメッセージのプロパティーをクリアできます。 メッセージのプロパティーが読み取り専用の場合、プロパティーを書き込み可能にすることができる唯一の方法は、アプリケーションがまずプロパティーをクリアすることです。

パラメーター:
message (入力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgDispose – メッセージの削除

インターフェース:
xmsRC xmsMsgDispose(xmsHMsg *message,
xmsHErrorBlock errorBlock);

メッセージを削除します。

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

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

xmsMsgGetJMSCorrelationID – JMSCorrelationID の取得

インターフェース:
xmsRC xmsMsgGetJMSCorrelationID(xmsHMsg message,
xmsCHAR *correlID,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

メッセージの相関 ID を取得します。

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

パラメーター:
message (入力)
メッセージのハンドル。
correlID (出力)
相関 ID を含むバッファー。
length (入力)
バッファーの長さ (バイト単位)。長さ 0 を指定すると、相関 ID は戻されずに、actualLength パラメーターに相関 ID の長さが戻されます。
actualLength (出力)
相関 ID の長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSDeliveryMode – JMSDeliveryMode の取得

インターフェース:
xmsRC xmsMsgGetJMSDeliveryMode(xmsHMsg message,
xmsINT *deliveryMode,
xmsHErrorBlock errorBlock);

メッセージの送達モードを取得します。送達モードは、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定されます。

パラメーター:
message (入力)
メッセージのハンドル。
deliveryMode (出力)
メッセージの送達モード。以下の値のいずれかです。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

新規に作成されて送信されていないメッセージの場合、送達モードは XMSC_DELIVERY_PERSISTENT です。ただし、送達モードが XMSC_DELIVERY_NON_PERSISTENT であるブローカーへのリアルタイム接続の場合を除きます。受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSDeliveryMode() を呼び出して送達モードを変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定された送達モードが戻されます。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSDestination – JMSDestination の取得

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

メッセージ宛先を取得します。宛先は、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定されます。

パラメーター:
message (入力)
メッセージのハンドル。
destination (出力)
メッセージの宛先のハンドル。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが xmsMsgSetJMSDestination() を呼び出して宛先を設定していない限り、この関数は NULL ハンドルおよびエラー・コード XMS_E_NOT_SET を戻します。受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSDestination() を呼び出して宛先を変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定された宛先のハンドルが戻されます。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSExpiration – JMSExpiration の取得

インターフェース:
xmsRC xmsMsgGetJMSExpiration(xmsHMsg message,
xmsLONG *expiration,
xmsHErrorBlock errorBlock);

メッセージの有効期限切れ時刻を取得します。

有効期限切れ時刻は、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定されます。その値は、送信側アプリケーションが指定した存続時間を、メッセージの送信時刻に加算して計算されます。有効期限切れ時刻は、1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表されます。

存続時間が 0 の場合、xmsMsgProducerSend() 呼び出しでは、有効期限切れ時刻が 0 に設定されますが、これはメッセージの有効期限がないことを示します。

XMS は、有効期限が切れたメッセージを廃棄し、アプリケーションに配信しません。

パラメーター:
message (入力)
メッセージのハンドル。
expiration (出力)
メッセージの有効期限切れ時刻。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが xmsMsgSetJMSExpiration() を呼び出して異なる有効期限切れ時刻を設定していない限り、有効期限切れ時刻は 0 です。受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSExpiration() を呼び出して有効期限切れ時刻を変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定された有効期限切れ時刻が戻されます。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSMessageID – JMSMessageID の取得

インターフェース:
xmsRC xmsMsgGetJMSMessageID(xmsHMsg message,
xmsCHAR *msgID,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

メッセージのメッセージ ID を取得します。メッセージ ID は、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定されます。

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

パラメーター:
message (入力)
メッセージのハンドル。
msgID (出力)
メッセージ ID を含むバッファー。

受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSMessageID() を呼び出してメッセージ ID を変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定されたメッセージ ID が戻されます。

length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、メッセージ ID は戻されませんが、actualLength パラメーターでメッセージ ID の長さが戻されます。
actualLength (出力)
メッセージ ID の長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
XMS_X_GENERAL_EXCEPTION
注:
  1. メッセージがメッセージ ID を持たない場合、関数はバッファーの内容を変更せずに残し、actualLength パラメーターを 0 に設定し、エラー・コード XMS_E_NOT_SET を戻します。

xmsMsgGetJMSPriority – JMSPriority の取得

インターフェース:
xmsRC xmsMsgGetJMSPriority(xmsHMsg message,
xmsINT *priority,
xmsHErrorBlock errorBlock);

メッセージの優先順位を取得します。優先順位は、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定されます。

パラメーター:
message (入力)
メッセージのハンドル。
priority (出力)
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが xmsMsgSetJMSPriority() を呼び出して異なる優先順位を設定していない限り、優先順位は 4 です。受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSPriority() を呼び出して優先順位を変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定された優先順位が戻されます。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSRedelivered – JMSRedelivered の取得

インターフェース:
xmsRC xmsMsgGetJMSRedelivered(xmsHMsg message,
xmsBOOL *redelivered,
xmsHErrorBlock errorBlock);

メッセージが再配信されるかどうかの標識を取得します。標識は、メッセージの受信時に xmsMsgConsumerReceive() 呼び出しによって設定されます。

パラメーター:
message (入力)
メッセージのハンドル。
redelivered (出力)
メッセージが再配信される場合、値は xmsTRUE です。メッセージが再配信されない場合、値は xmsFALSE です。

ブローカーへのリアルタイム接続の場合、常に値は xmsFALSE です。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSReplyTo – JMSReplyTo の取得

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

メッセージに対する応答が送信される宛先を取得します。

パラメーター:
message (入力)
メッセージのハンドル。
destination (出力)
メッセージに対する応答が送信される宛先のハンドル。NULL ハンドルは、応答が予期されていないことを意味します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSTimestamp – JMSTimestamp の取得

インターフェース:
xmsRC xmsMsgGetJMSTimestamp(xmsHMsg message,
xmsLONG *timeStamp,
xmsHErrorBlock errorBlock);

メッセージが送信された時刻を取得します。タイム・スタンプは、メッセージの送信時に xmsMsgProducerSend() 呼び出しによって設定され、1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表されます。

パラメーター:
message (入力)
メッセージのハンドル。
timeStamp (出力)
メッセージが送信された時刻。

新規に作成されて送信されていないメッセージの場合、送信側アプリケーションが xmsMsgSetJMSTimestamp() を呼び出して異なるタイム・スタンプを設定していない限り、タイム・スタンプは 0 です。受信されたメッセージについては、受信側アプリケーションが xmsMsgSetJMSTimestamp() を呼び出してタイム・スタンプを変更していない限り、この関数では、メッセージ送信時に xmsMsgProducerSend() 呼び出しによって設定されたタイム・スタンプが戻されます。

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
注:
  1. タイム・スタンプが未定義である場合、関数は timeStamp パラメーターを 0 に設定しますが、エラーは戻しません。

xmsMsgGetJMSType – JMSType の取得

インターフェース:
xmsRC xmsMsgGetJMSType(xmsHMsg message,
xmsCHAR *type,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

メッセージのタイプを取得します。

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

パラメーター:
message (入力)
メッセージのハンドル。
type (出力)
メッセージのタイプを含むバッファー。データ変換が必要な場合、これは変換後のタイプです。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、メッセージのタイプは戻されませんが、actualLength パラメーターでメッセージのタイプの長さが戻されます。
actualLength (出力)
メッセージのタイプの長さ (バイト単位)。データ変換が必要な場合、これは変換後の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetProperties – プロパティーの取得

インターフェース:
xmsRC xmsMsgGetProperties(xmsHMsg message,
xmsHIterator *iterator,
xmsHErrorBlock errorBlock);

メッセージのプロパティーのリストを取得します。

この関数は、Property オブジェクトのリストをカプセル化するイテレーターを戻します。アプリケーションは、そのイテレーターを使用して、各プロパティーに順番にアクセスすることができます。

注: 同等の JMS メソッドでは、多少異なる働きをします。JMS メソッドでは、メッセージのプロパティーの名前のみを列挙した形で戻し、値は戻しません。
パラメーター:
message (入力)
メッセージのハンドル。
iterator (出力)
イテレーターのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetTypeId – タイプの取得

インターフェース:
xmsRC xmsMsgGetTypeId(xmsHMsg message,
xmsMESSAGE_TYPE *type,
xmsHErrorBlock errorBlock);

メッセージの本体タイプを取得します。

メッセージの本体タイプについては、XMS メッセージの本文を参照してください。

パラメーター:
message (入力)
メッセージのハンドル。
type (出力)
メッセージの本体タイプ。以下の値のいずれかです。
  • XMS_MESSAGE_TYPE_BASE (メッセージは本体を持たない)
  • XMS_MESSAGE_TYPE_BYTES
  • XMS_MESSAGE_TYPE_MAP
  • XMS_MESSAGE_TYPE_OBJECT
  • XMS_MESSAGE_TYPE_STREAM
  • XMS_MESSAGE_TYPE_TEXT
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgPropertyExists – プロパティーの存在の検査

インターフェース:
xmsRC xmsMsgPropertyExists(xmsHMsg message,
xmsCHAR *propertyName,
xmsBOOL *propertyExists,
xmsHErrorBlock errorBlock);

メッセージに、指定された名前のプロパティーがあるかどうかを検査します。

パラメーター:
message (入力)
メッセージのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyExists (出力)
メッセージに、指定された名前のプロパティーがある場合、値は xmsTRUE です。メッセージに、指定された名前のプロパティーがない場合、値は xmsFALSE です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSCorrelationID – JMSCorrelationID の設定

インターフェース:
xmsRC xmsMsgSetJMSCorrelationID(xmsHMsg message,
xmsCHAR *correlID,
xmsINT length,
xmsHErrorBlock errorBlock);

メッセージの相関 ID を設定します。

パラメーター:
message (入力)
メッセージのハンドル。
correlID (入力)
文字配列としての相関 ID。
length (入力)
相関 ID の長さ (バイト単位)。相関 ID がヌルで、終了文字としてヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が相関 ID の長さを計算できるようにすることも可能です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSDeliveryMode – JMSDeliveryMode の設定

インターフェース:
xmsRC xmsMsgSetJMSDeliveryMode(xmsHMsg message,
xmsINT deliveryMode,
xmsHErrorBlock errorBlock);

メッセージの送達モードを設定します。

メッセージの送信前にこの関数が設定した送達モードは、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージの送達モードを変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSDestination – JMSDestination の設定

インターフェース:
xmsRC xmsMsgSetJMSDestination(xmsHMsg message,
xmsHDest destination,
xmsHErrorBlock errorBlock);

メッセージ宛先を設定します。

メッセージの送信前にこの関数が設定した宛先は、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージの宛先を変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
destination (入力)
メッセージの宛先のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSExpiration – JMSExpiration の設定

インターフェース:
xmsRC xmsMsgSetJMSExpiration(xmsHMsg message,
xmsLONG expiration,
xmsHErrorBlock errorBlock);

メッセージの有効期限切れ時刻を設定します。

メッセージの送信前にこの関数が設定した有効期限切れ時刻は、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージの有効期限切れ時刻を変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
expiration (入力)
1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表される有効期限切れ時刻。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSMessageID – JMSMessageID の設定

インターフェース:
xmsRC xmsMsgSetJMSMessageID(xmsHMsg message,
xmsCHAR *msgID,
xmsINT length,
xmsHErrorBlock errorBlock);

メッセージのメッセージ ID を設定します。

メッセージの送信前にこの関数が設定したメッセージ ID は、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージのメッセージ ID を変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
msgID (入力)
文字配列としてのメッセージ ID。
length (入力)
メッセージ ID の長さ (バイト単位)。メッセージ ID がヌルで、終了文字としてヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS がメッセージ ID の長さを計算できるようにすることも可能です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSPriority – JMSPriority の設定

インターフェース:
xmsRC xmsMsgSetJMSPriority(xmsHMsg message,
xmsINT priority,
xmsHErrorBlock errorBlock);

メッセージの優先順位を設定します。

メッセージの送信前にこの関数が設定した優先順位は、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージの優先順位を変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
priority (入力)
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSRedelivered – JMSRedelivered の設定

インターフェース:
xmsRC xmsMsgSetJMSRedelivered(xmsHMsg message,
xmsBOOL redelivered,
xmsHErrorBlock errorBlock);

メッセージが再配信されるかどうかを示します。

メッセージの送信前にこの関数が設定した再配信の標識は、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視され、メッセージ受信時の xmsMsgConsumerReceive() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージの標識を変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
redelivered (入力)
xmsTRUE は、メッセージが再配信されることを意味します。値 xmsFALSE は、メッセージが再配信されないことを意味します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSReplyTo – JMSReplyTo の設定

インターフェース:
xmsRC xmsMsgSetJMSReplyTo(xmsHMsg message,
xmsHDest destination,
xmsHErrorBlock errorBlock);

メッセージに対する応答が送信される宛先を設定します。

パラメーター:
message (入力)
メッセージのハンドル。
destination (入力)
メッセージに対する応答が送信される宛先のハンドル。NULL ハンドルは、応答が予期されていないことを意味します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSTimestamp – JMSTimestamp の設定

インターフェース:
xmsRC xmsMsgSetJMSTimestamp(xmsHMsg message,
xmsLONG timeStamp,
xmsHErrorBlock errorBlock);

メッセージが送信される時刻を設定します。

メッセージの送信前にこの関数が設定したタイム・スタンプは、メッセージの送信時の xmsMsgProducerSend() 呼び出しでは無視されて置き換えられます。ただし、この関数を使用して、受信されたメッセージのタイム・スタンプを変更することができます。

パラメーター:
message (入力)
メッセージのハンドル。
timeStamp (入力)
1970 年 1 月 1 日 00:00:00 GMT からのミリ秒で表される、メッセージ送信の時刻。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSType – JMSType の設定

インターフェース:
xmsRC xmsMsgSetJMSType(xmsHMsg message,
xmsCHAR *type,
xmsINT length,
xmsHErrorBlock errorBlock);

メッセージのタイプを設定します。

パラメーター:
message (入力)
メッセージのハンドル。
type (入力)
文字配列としてのメッセージのタイプ。
length (入力)
メッセージのタイプの長さ (バイト単位)。メッセージのタイプがヌルで、終了文字としてヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS がメッセージのタイプの長さを計算できるようにすることも可能です。
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)