ストリーム・メッセージとは、本体が値のストリームで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。
xms::PropertyContext | +----xms::Message | +----xms::StreamMessage
本体の内容は、順番に読み書きされます。
アプリケーションがメッセージ・ストリームから値を読み取るとき、値は XMS によって別のデータ型に変換される可能性があります。この形式の暗黙の型変換について詳しくは、ストリーム・メッセージを参照してください。
メソッド | 説明 |
---|---|
readBoolean | メッセージ・ストリームからブール値を読み取ります。 |
readByte | メッセージ・ストリームから符号付き 8 ビット整数を読み取ります。 |
readBytes | メッセージ・ストリームからバイトの配列を読み取ります。 |
readChar | メッセージ・ストリームから 2 バイト文字を読み取ります。 |
readDouble | メッセージ・ストリームから 8 バイトの倍精度浮動小数点数を読み取ります。 |
readFloat | メッセージ・ストリームから 4 バイトの浮動小数点数を読み取ります。 |
readInt | メッセージ・ストリームから符号付き 32 ビット整数を読み取ります。 |
readLong | メッセージ・ストリームから符号付き 64 ビット整数を読み取ります。 |
readObject | メッセージ・ストリームから値を読み取り、そのデータ型を戻します。 |
readShort | メッセージ・ストリームから符号付き 16 ビット整数を読み取ります。 |
readString | メッセージ・ストリームからストリングを読み取ります。 |
reset | メッセージの本体を読み取り専用モードにして、カーソルをメッセージ・ストリームの先頭に位置変更します。 |
writeBoolean | メッセージ・ストリームへブール値を書き込みます。 |
writeByte | メッセージ・ストリームへバイトを書き込みます。 |
writeBytes | メッセージ・ストリームへバイトの配列を書き込みます。 |
writeChar | 文字を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。 |
writeDouble | 倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。 |
writeFloat | 浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。 |
writeInt | 整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。 |
writeLong | 長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。 |
writeObject | メッセージ・ストリームに、指定されたデータ型の値を書き込みます。 |
writeShort | 短整数を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。 |
writeString | メッセージ・ストリームへストリングを書き込みます。 |
xmsINT readBytes(xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *returnedLength) const;
配列のバイト数が、バッファーの長さ以下である場合は、配列全体がバッファーに読み取られます。配列のバイト数がバッファーの長さを超える場合、配列の一部でバッファーはいっぱいになり、内部カーソルは次に読み取られるバイトの位置をマークします。 次に readBytes() を呼び出すと、カーソルの現在位置から始まる配列から、バイトが読み取られます。
入力に NULL ポインターを指定すると、呼び出しではそのバイトの配列は読み取られずにスキップオーバーされます。
入力に NULL ポインターを指定すると、メソッドは値を戻しません。
xmsOBJECT_TYPE readObject(xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *actualLength) const;
メッセージ・ストリームから値を読み取り、そのデータ型を戻します。
このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。
入力に NULL ポインターを指定すると、呼び出しはその値を読み取らずにスキップします。
xmsVOID writeObject(const xmsOBJECT_TYPE objectType, const xmsSBYTE *value, const xmsINT length);
メッセージ・ストリームに、指定されたデータ型の値を書き込みます。