NdisGetDataBuffer (Compact 7)

3/12/2014

Call this function to gain access to a contiguous block of data from a NET_BUFFER structure.

Syntax

PVOID
  NdisGetDataBuffer(
    IN PNET_BUFFER  NetBuffer,
    IN ULONG  BytesNeeded,
    IN PVOID  Storage,
    IN UINT   AlignMultiple,
    IN UINT   AlignOffset
    );

Parameters

• NetBuffer
  A pointer to a NET_BUFFER structure.

• BytesNeeded
  The number of contiguous bytes of data requested.

• Storage
  A pointer to a buffer, or NULL if no buffer is provided by the caller. The buffer must be greater than or equal in size to the number of bytes specified in BytesNeeded. If this value is non-NULL, and the data requested is not contiguous, NDIS copies the requested data to the area indicated by Storage.

• AlignMultiple
  The alignment multiple expressed in power of two. For example, 2, 4, 8, 16, and so on. If AlignMultiple is 1, there is no alignment requirement.

• AlignOffset
  The offset, in bytes, from the alignment multiple.

Return Value

NdisGetDataBuffer returns a pointer to the start of the contiguous data or it returns NULL.

If the DataLength member of the NET_BUFFER_DATA structure in the NET_BUFFER structure that the NetBuffer parameter points to is less than the value in the BytesNeeded parameter, the return value is NULL.

If the requested data in the buffer is contiguous, this return value is a pointer to a location that NDIS provides. If the data is not contiguous, NDIS uses the Storage parameter as follows:

• If the Storage parameter is non-NULL, NDIS copies the data to the buffer at Storage. This return value is the pointer that is passed to the Storage parameter.
• If the Storage parameter is NULL, this return value is NULL.

Remarks

Call this function to obtain a pointer to a network data header contained in the NET_BUFFER structure. You can easily parse the header stored in the contiguous data block that this function returns.

The requested alignment requirement is expressed as a power-of-two multiple plus an offset. For example, if AlignMultiple is 4 and AlignOffset is 3 then the data address should be a multiple of 4 plus 3. If it is necessary, NDIS will allocate memory to satisfy the alignment requirement.

Requirements

See Also

Reference

NDIS NET_BUFFER Functions
NET_BUFFER
NET_BUFFER_DATA