WdfCommonBufferGetAlignedVirtualAddress function (wdfcommonbuffer.h)

[Applies to KMDF only]

The WdfCommonBufferGetAlignedVirtualAddress method returns the virtual address that is associated with a specified common buffer.

Syntax

PVOID WdfCommonBufferGetAlignedVirtualAddress(
  WDFCOMMONBUFFER CommonBuffer
);

Parameters

CommonBuffer

[in] A handle to a common buffer object that the driver obtained by a previous call to WdfCommonBufferCreate.

Return value

WdfCommonBufferGetAlignedVirtualAddress returns the virtual address of the buffer that is associated with the common buffer that the CommonBuffer parameter specifies.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

If the driver called WdfDeviceSetAlignmentRequirement to set a buffer alignment requirement, the framework aligns the common buffer according to that alignment requirement.

For more information about common buffers, see Using Common Buffers

Examples

For a code example that uses WdfCommonBufferGetAlignedVirtualAddress, see WdfCommonBufferCreate.

Requirements

   
Target Platform Universal
Minimum KMDF version 1.0
Header wdfcommonbuffer.h (include WdfCommonBuffer.h)
Library Wdf01000.sys (see Framework Library Versioning.)
IRQL <= DISPATCH_LEVEL
DDI compliance rules DriverCreate, KmdfIrql, KmdfIrql2

See also

WdfCommonBufferCreate

WdfCommonBufferGetAlignedLogicalAddress

WdfDeviceSetAlignmentRequirement