Retrieve Buffer Data Length (QsnRtvBufLen) API

The Retrieve Buffer Data Length (QsnRtvBufLen) API returns the number of bytes of command data in a command buffer or of input data in an input buffer. After an indirect operation is applied to a command buffer, the QsnRtvBufLen API result reflects the increase in the underlying command stream to accommodate the command.

Authorities and Locks

None

Required Parameter

Buffer handle

INPUT; BINARY(4)

A handle for the buffer to be queried.

Omissible Parameter Group

Buffer data length

OUTPUT; BINARY(4)

The variable containing the buffer data length after the QsnRtvBufLen API has completed.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Returned Value

Buffer data length

OUTPUT; BINARY(4)

This API returns the value for the buffer data length parameter, or -1 otherwise.

Error Messages