Edit

Share via

SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST function (spb.h)

  • Article

The SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST function returns an SPB_TRANSFER_LIST_ENTRY structure that is initialized to describe a scatter-gather list.

Syntax

SPB_TRANSFER_LIST_ENTRY SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST(
  [in] SPB_TRANSFER_DIRECTION            Direction,
  [in] ULONG                             DelayInUs,
  [in] SPB_TRANSFER_BUFFER_LIST_ENTRY [] BufferList,
  [in] ULONG                             BufferListCe
);

Parameters

[in] Direction

The direction of the transfer. The function writes this value to the Direction member of the SPB_TRANSFER_LIST_ENTRY structure.

[in] DelayInUs

An optional delay in microseconds. The function writes this value to the DelayInUs member of the SPB_TRANSFER_LIST_ENTRY structure.

[in] BufferList

A pointer to an array of SPB_TRANSFER_BUFFER_LIST_ENTRY structures that describes a scatter-gather list. The function writes this value to the Buffer.BufferList.List member of the SPB_TRANSFER_LIST_ENTRY structure. For more information, see the description of the BufferList.List member in SPB_TRANSFER_BUFFER.

[in] BufferListCe

The number of buffers in the scatter-gather list pointed to by BufferList. The function writes this value to the Buffer.BufferList.ListCe member of the SPB_TRANSFER_LIST_ENTRY structure. For more information, see the description of the BufferList.ListCe member in SPB_TRANSFER_BUFFER.

Return value

SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST returns an initialized SPB_TRANSFER_LIST_ENTRY structure.

Remarks

This initialization function returns an unnamed local variable of type SPB_TRANSFER_LIST_ENTRY. The storage for this variable is allocated in the caller's stack frame and is valid while the stack frame remains in scope.

SPB_TRANSFER_LIST_ENTRY_INIT_BUFFER_LIST sets the Buffer.Format member of the SPB_TRANSFER_LIST_ENTRY structure to SpbTransferBufferFormatList. For more information about buffer formats, see SPB_TRANSFER_BUFFER_FORMAT.

Requirements

Requirement Value
Target Platform Desktop
Header spb.h
IRQL Any IRQL

See also