- インターフェース:
xmsINT getObject(xmsSBYTE *buffer,
xmsINT bufferLength,
xmsINT *actualLength);
オブジェクト・メッセージの本体を形成するオブジェクトを取得します。
このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。
- パラメーター:
- buffer (出力)
- バイトの配列として戻されるオブジェクトを含むバッファー。
- bufferLength (入力)
- バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、オブジェクトは戻されませんが、actualLength パラメーターでオブジェクトの長さが戻されます。
- actualLength (出力)
- オブジェクトの長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
- 戻り値:
- オブジェクトの長さ (バイト単位)。
- 例外:
- XMS_X_GENERAL_EXCEPTION
- XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
- XMS_X_MESSAGE_EOF_EXCEPTION
注: - バッファーが、オブジェクト全体を保管するのに十分な大きさではない場合、XMS は、バッファーの長さまで切り捨てられたオブジェクトを戻し、actualLength パラメーターにオブジェクトの実際の長さを設定し、エラー・コード XMS_E_DATA_TRUNCATED を戻します。
- オブジェクトの取得の試行中に別のエラーが発生した場合、XMS はエラーを報告しますが、actualLength パラメーターを設定しません。