Edit

Share via

VHF_CONFIG_INIT function (vhf.h)

  • Article

Use the VHF_CONFIG_INIT function to initialize the required members of the VHF_CONFIG structure allocated by the HID source driver.

Syntax

FORCEINLINE
VOID
VHF_CONFIG_INIT(
    _Out_
        PVHF_CONFIG     Config,
#ifdef _KERNEL_MODE
    _In_
        PDEVICE_OBJECT  DeviceObject,
#else
    _In_
        HANDLE          FileHandle,
#endif
    _In_
        USHORT          ReportDescriptorLength,
    _In_reads_bytes_(ReportDescriptorLength)
        PUCHAR          ReportDescriptor    
    )

Parameters

[out] Config

A pointer to the VHF_CONFIG structure to initialize.

[in] DeviceObject

A pointer to the DEVICE_OBJECT structure for the HID source driver. Get that pointer by calling WdfDeviceWdmGetDeviceObject and passing the WDFDEVICE handle that the driver received in the WdfDeviceCreate call.

A user-mode driver would instead provide a FileHandle. For more info, see VHF_CONFIG.

[in] ReportDescriptorLength

The length of the HID Report Descriptor contained in a buffer pointer by ReportDescriptor.

ReportDescriptor

A pointer to a HID source driver-allocated buffer that contains the HID Report Descriptor.

Return value

None

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server None supported
Target Platform Desktop
Header vhf.h
Library VhfKm.lib

See also

Write a HID source driver by using Virtual HID Framework (VHF)