Edit

Share via

SPB_TRANSFER_LIST_ENTRY_INIT_NON_PAGED function (spb.h)

  • Article

The SPB_TRANSFER_LIST_ENTRY_INIT_NON_PAGED function returns an SPB_TRANSFER_LIST_ENTRY structure that is initialized to describe a simple data buffer in non-paged memory.

Syntax

SPB_TRANSFER_LIST_ENTRY SPB_TRANSFER_LIST_ENTRY_INIT_NON_PAGED(
  [in] SPB_TRANSFER_DIRECTION Direction,
  [in] ULONG                  DelayInUs,
  [in] PVOID                  Buffer,
  [in] ULONG                  BufferCb
);

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] Buffer

A pointer to a data buffer. The function writes this value to the Buffer.Simple.Buffer member of the SPB_TRANSFER_LIST_ENTRY structure. For more information, see the description of the Buffer member in SPB_TRANSFER_BUFFER_LIST_ENTRY.

[in] BufferCb

The size, in bytes, of the buffer pointed to by Buffer. The function writes this value to the Buffer.Simple.BufferCb member of the SPB_TRANSFER_LIST_ENTRY structure. For more information, see the description of the BufferCb member in SPB_TRANSFER_BUFFER_LIST_ENTRY.

Return value

SPB_TRANSFER_LIST_ENTRY_INIT_NON_PAGED 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_NON_PAGED sets the Buffer.Format member of the SPB_TRANSFER_LIST_ENTRY structure to SpbTransferBufferFormatSimpleNonPaged. 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