KsInitializeDriver function (ks.h)

Article
02/22/2024

The KsInitializeDriver function initializes the driver object of an AVStream minidriver.

Syntax

KSDDKAPI NTSTATUS KsInitializeDriver(
  [in]           PDRIVER_OBJECT            DriverObject,
  [in]           PUNICODE_STRING           RegistryPathName,
  [in, optional] const KSDEVICE_DESCRIPTOR *Descriptor
);

Parameters

[in] DriverObject

A pointer to the DRIVER_OBJECT structure for the AVStream driver being initialized. Minidrivers that call KsInitializeDriver should use the driver object passed to DriverEntry by the operating system.

[in] RegistryPathName

A pointer to a Unicode string containing the registry path string passed into the minidriver's DriverEntry function by the operating system.

[in, optional] Descriptor

A pointer to a KSDEVICE_DESCRIPTOR structure that specifies the characteristics of the device being initialized. If this pointer is NULL, a device is created with default characteristics and no associated filter factories.

Return value

KsInitializeDriver returns STATUS_SUCCESS or an appropriate error code as returned by IoCreateDevice or internal AVStream device initialization routines.

Remarks

This function is typically called from DriverEntry. If the minidriver passes in a device descriptor, AVStream creates a device with the specified characteristics at AddDevice time. Minidrivers that perform device initialization themselves do not necessarily need to call KsInitializeDriver. For more information, see Initializing an AVStream Minidriver.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	PASSIVE_LEVEL