WdfCommonBufferGetAlignedLogicalAddress function (wdfcommonbuffer.h)

[Applies to KMDF only]

The WdfCommonBufferGetAlignedLogicalAddress method returns the logical address that is associated with a specified common buffer.

Syntax

PHYSICAL_ADDRESS WdfCommonBufferGetAlignedLogicalAddress(
  [in] WDFCOMMONBUFFER CommonBuffer
);

Parameters

[in] CommonBuffer

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

Return value

WdfCommonBufferGetAlignedLogicalAddress returns the logical 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

Logical addresses are mapped addresses that devices use to access physical memory.

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 WdfCommonBufferGetAlignedLogicalAddress, see WdfCommonBufferCreate.

Requirements

Requirement Value
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(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

See also

WdfCommonBufferCreate

WdfCommonBufferGetAlignedVirtualAddress

WdfDeviceSetAlignmentRequirement