ストリーム・メッセージとは、本体が値のストリームで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。
本体の内容は、順番に読み書きされます。
アプリケーションがメッセージ・ストリームから値を読み取るとき、値は XMS によって別のデータ型に変換される可能性があります。この形式の暗黙の型変換について詳しくは、ストリーム・メッセージを参照してください。
関数 | 説明 |
---|---|
xmsStreamMsgReadBoolean | メッセージ・ストリームからブール値を読み取ります。 |
xmsStreamMsgReadByte | メッセージ・ストリームから符号付き 8 ビット整数を読み取ります。 |
xmsStreamMsgReadBytes | メッセージ・ストリームからバイトの配列を読み取ります。 |
xmsStreamMsgReadBytesByRef | メッセージ・ストリームでのバイトの配列へのポインターを取得し、配列の長さを取得します。 |
xmsStreamMsgReadChar | メッセージ・ストリームから 2 バイト文字を読み取ります。 |
xmsStreamMsgReadDouble | メッセージ・ストリームから 8 バイトの倍精度浮動小数点数を読み取ります。 |
xmsStreamMsgReadFloat | メッセージ・ストリームから 4 バイトの浮動小数点数を読み取ります。 |
xmsStreamMsgReadInt | メッセージ・ストリームから符号付き 32 ビット整数を読み取ります。 |
xmsStreamMsgReadLong | メッセージ・ストリームから符号付き 64 ビット整数を読み取ります。 |
xmsStreamMsgReadObject | メッセージ・ストリームから値を読み取り、そのデータ型を戻します。 |
xmsStreamMsgReadShort | メッセージ・ストリームから符号付き 16 ビット整数を読み取ります。 |
xmsStreamMsgReadString | メッセージ・ストリームからストリングを読み取ります。 |
xmsStreamMsgReset | メッセージの本体を読み取り専用モードにして、カーソルをメッセージ・ストリームの先頭に位置変更します。 |
xmsStreamMsgWriteBoolean | メッセージ・ストリームへブール値を書き込みます。 |
xmsStreamMsgWriteByte | メッセージ・ストリームへバイトを書き込みます。 |
xmsStreamMsgWriteBytes | メッセージ・ストリームへバイトの配列を書き込みます。 |
xmsStreamMsgWriteChar | 文字を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteDouble | 倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteFloat | 浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteInt | 整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteLong | 長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteObject | メッセージ・ストリームに、指定されたデータ型の値を書き込みます。 |
xmsStreamMsgWriteShort | 短整数を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。 |
xmsStreamMsgWriteString | メッセージ・ストリームへストリングを書き込みます。 |
xmsRC xmsStreamMsgReadBoolean(xmsHMsg message, xmsBOOL *value, xmsHErrorBlock errorBlock);
xmsRC xmsStreamMsgReadByte(xmsHMsg message, xmsSBYTE *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから符号付き 8 ビット整数を読み取ります。
xmsRC xmsStreamMsgReadBytes(xmsHMsg message, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *returnedLength, xmsHErrorBlock errorBlock);
配列のバイト数が、バッファーの長さ以下である場合は、配列全体がバッファーに読み取られます。配列のバイト数がバッファーの長さを超える場合、配列の一部でバッファーはいっぱいになり、内部カーソルは次に読み取られるバイトの位置をマークします。 次に xmsStreamMsgReadBytes() を呼び出すと、カーソルの現在位置から始まる配列から、バイトが読み取られます。
入力に NULL ポインターを指定すると、呼び出しではそのバイトの配列は読み取られずにスキップオーバーされます。
入力に NULL ポインターを指定すると、関数は値を戻しません。
xmsRC xmsStreamMsgReadBytesByRef(xmsHMsg message, xmsSBYTE **array, xmsINT *length, xmsHErrorBlock errorBlock);
メッセージ・ストリームでのバイトの配列へのポインターを取得し、配列の長さを取得します。
この関数の使用方法について詳しくは、参照によりストリングまたはバイト配列を戻す C 関数を参照してください。
xmsRC xmsStreamMsgReadChar(xmsHMsg message, xmsCHAR16 *value, xmsHErrorBlock errorBlock);
xmsRC xmsStreamMsgReadDouble(xmsHMsg message, xmsDOUBLE *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから 8 バイトの倍精度浮動小数点数を読み取ります。
xmsRC xmsStreamMsgReadFloat(xmsHMsg message, xmsFLOAT *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから 4 バイトの浮動小数点数を読み取ります。
xmsRC xmsStreamMsgReadInt(xmsHMsg message, xmsINT *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから符号付き 32 ビット整数を読み取ります。
xmsRC xmsStreamMsgReadLong(xmsHMsg message, xmsLONG *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから符号付き 64 ビット整数を読み取ります。
xmsRC xmsstreamMsgReadObject(xmsHMsg message, xmsSBYTE *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsOBJECT_TYPE *objectType, xmsHErrorBlock errorBlock);
メッセージ・ストリームから値を読み取り、そのデータ型を戻します。
この関数の使用方法について詳しくは、値によりバイト配列を戻す C 関数を参照してください。
入力に NULL ポインターを指定すると、呼び出しはその値を読み取らずにスキップします。
xmsRC xmsStreamMsgReadShort(xmsHMsg message, xmsSHORT *value, xmsHErrorBlock errorBlock);
メッセージ・ストリームから符号付き 16 ビット整数を読み取ります。
xmsRC xmsStreamMsgReadString(xmsHMsg message, xmsCHAR *buffer, xmsINT bufferLength, xmsINT *actualLength, xmsHErrorBlock errorBlock);
メッセージ・ストリームからストリングを読み取ります。必要な場合、XMS がストリング内の文字をローカル・コード・ページに変換します。
この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。
XMSC_QUERY_SIZE を指定すると、ストリングは戻されませんが、actualLength パラメーターでストリング長が戻され、カーソルは拡張されません。
XMSC_SKIP を指定すると、関数はそのストリングを読み取らずにスキップします。
xmsRC xmsStreamMsgWriteBytes(xmsHMsg message, xmsSBYTE *value, xmsINT length, xmsHErrorBlock errorBlock);
xmsRC xmsStreamMsgWriteChar(xmsHMsg message, xmsCHAR16 value, xmsHErrorBlock errorBlock);
文字を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。
xmsRC xmsStreamMsgWriteDouble(xmsHMsg message, xmsDOUBLE value, xmsHErrorBlock errorBlock);
倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。
xmsRC xmsStreamMsgWriteFloat(xmsHMsg message, xmsFLOAT value, xmsHErrorBlock errorBlock);
浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。
xmsRC xmsStreamMsgWriteLong(xmsHMsg message, xmsLONG value, xmsHErrorBlock errorBlock);
長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。
xmsRC xmsStreamMsgWriteObject(xmsHMsg message, xmsSBYTE *value, xmsINT length, xmsOBJECT_TYPE objectType, xmsHErrorBlock errorBlock);
メッセージ・ストリームに、指定されたデータ型の値を書き込みます。
xmsRC xmsStreamMsgWriteShort(xmsHMsg message, xmsSHORT value, xmsHErrorBlock errorBlock);
短整数を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。
xmsRC xmsStreamMsgWriteString(xmsHMsg message, xmsCHAR *value, xmsINT length, xmsHErrorBlock errorBlock);