2.2.3.1.1.5.2 RopFastTransferSourceGetBuffer ROP Response Buffer

The following descriptions define valid fields for the response buffer of the RopFastTransferSourceGetBuffer ROP ([MS-OXCROPS] section 2.2.12.3).

ReturnValue (4 bytes): An unsigned 32-bit integer. This value represents the ROP execution status. For more details, see sections 3.3.5.7.1 and 3.2.5.8.1.5.

TransferStatus (2 bytes): A 16-bit enumeration. This field represents the status of the download operation after producing data for the TransferBuffer field.

The following table defines valid values for the TransferStatus field.

Value

Bit

Description

Error

0x0000

The download stopped because a nonrecoverable error has occurred when producing a FastTransfer stream. The ReturnValue field of the ROP response buffer contains a code for that error.

Partial

0x0001

The FastTransfer stream was split, and more data is available. TransferBuffer contains incomplete data. For details about where to split FastTransfer streams, see section 2.2.4.1.

NoRoom

0x0002

The FastTransfer stream was split, more data is available, and the value of the TransferBuffer field contains incomplete data. The server MAY<8> set this value.

Done

0x0003

This was the last portion of the FastTransfer stream.

InProgressCount (2 bytes): An unsigned 16-bit integer. The number of steps that have already been completed in the current operation. This value is only usable for progress information display.

TotalStepCount (2 bytes): An unsigned 16-bit integer that contains the approximate total number of steps to be completed in the current operation. This value MAY<9> contain accurate information and is only usable for progress information display.

Reserved (1 byte): The value of this field MUST be set to 0x00 when sending and ignored on receipt.

TransferBufferSize (2 bytes): An unsigned 16-bit integer. This value specifies the size of the TransferBuffer field.

TransferBuffer (variable, optional): An array of bytes that contains the next portion of a FastTransfer stream. The syntax of the FastTransfer stream is specified in section 2.2.4. This field SHOULD only exist if the value of the ReturnValue field is Success (0x00000000).

BackoffTime (4 bytes, optional): An unsigned 32-bit integer that contains the time, in milliseconds, that a client waits before retrying the ROP. This field MUST be present if and only if the value of the ReturnValue field is 0x00000480, as specified in [MS-OXCDATA] section 2.4.

Show: