PGET_DEVICE_INFORMATION callback function (hdaudio.h)

Article
02/22/2024

The GetDeviceInformation routine retrieves information about the HD Audio controller device.

The function pointer type for a GetDeviceInformation routine is defined as follows.

Syntax

PGET_DEVICE_INFORMATION PgetDeviceInformation;

NTSTATUS PgetDeviceInformation(
  [in]      PVOID _context,
  [in, out] PHDAUDIO_DEVICE_INFORMATION DeviceInformation
)
{...}

Parameters

[in] _context

Specifies the context value from the Context member of the HDAUDIO_BUS_INTERFACE or the HDAUDIO_BUS_INTERFACE_V2 structure.

[in, out] DeviceInformation

Retrieves information about the HD Audio controller device. This parameter points to a caller-allocated HDAUDIO_DEVICE_INFORMATION structure into which the routine writes the device information.

Return value

GetDeviceInformation returns STATUS_SUCCESS if the call succeeds. Otherwise, the routine returns an appropriate error code. The following table shows a possible return status code.

Return code	Description
STATUS_BUFFER_TOO_SMALL	Indicates that the size specified at the beginning of the deviceInformation buffer is too small.

Remarks

This routine retrieves device-dependent information that is static-that is, the information does not change dynamically over time.

The deviceInformation parameter is a pointer to a buffer that contains an HDAUDIO_DEVICE_INFORMATION structure into which the routine writes information about the HD Audio controller. Before calling GetDeviceInformation, the caller allocates the buffer and writes the buffer's size in bytes into the Size member at the beginning of the buffer.

Requirements

Requirement	Value
Target Platform	Desktop
Header	hdaudio.h (include Hdaudio.h)
IRQL	PASSIVE_LEVEL