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

TextMessage

テキスト・メッセージとは、本体がストリングからなるメッセージです。

関連資料
テキスト・メッセージ

関数

関数の要約:
関数 説明
xmsTextMsgGetText テキスト・メッセージの本体を形成するストリングを取得します。
xmsTextMsgSetText テキスト・メッセージの本体を形成するストリングを設定します。

xmsTextMsgGetText – テキストの取得

インターフェース:
xmsRC xmsTextMsgGetText(xmsHMsg message,
xmsCHAR *buffer,
xmsINT bufferLength,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

テキスト・メッセージの本体を形成するストリングを取得します。必要な場合、XMS がストリング内の文字をローカル・コード・ページに変換します。

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

パラメーター:
message (入力)
メッセージのハンドル。
buffer (出力)
ストリングを含むバッファー。データ変換が必要な場合、これは変換後のストリングです。
bufferLength (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、ストリングは戻されませんが、actualLength パラメーターでストリング長が戻されます。
actualLength (出力)
ストリングの長さ (バイト単位)。データ変換が必要な場合、これは変換後のストリング長です。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION
注:
  1. バッファーが、ストリング全体を保管するのに十分な大きさではない場合、XMS は、バッファーの長さまで切り捨てられたストリングを戻し、actualLength パラメーターにストリングの実際の長さを設定し、エラー・コード XMS_E_DATA_TRUNCATED を戻します。
  2. ストリングの取得の試行中に別のエラーが発生した場合、XMS はエラーを報告しますが、actualLength パラメーターを設定しません。

xmsTextMsgSetText – テキストの設定

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

テキスト・メッセージの本体を形成するストリングを設定します。

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

Reference topic

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

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