PFNKSDEVICEIRP callback function (ks.h)

Article
03/08/2023

An AVStream minidriver's IRP handler routine is called when these IRPs is dispatched by the device.

Syntax

PFNKSDEVICEIRP Pfnksdeviceirp;

NTSTATUS Pfnksdeviceirp(
  [in] PKSDEVICE Device,
  [in] PIRP Irp
)
{...}

Parameters

[in] Device

Pointer to the KSDEVICE that dispatched the IRP.

[in] Irp

The IRP issued by Device.

Return value

Should return STATUS_SUCCESS or the error code that was returned from the attempt to perform the operation. If this is not the case, return an appropriate error code.

Remarks

IRP	Description
IRP_MN_QUERY_REMOVE_DEVICE	The minidriver specifies this routine's address in the QueryRemove member of its KSDEVICE_DISPATCH structure. This routine is called when an IRP_MN_QUERY_REMOVE_DEVICE is dispatched by the device. It will usually be provided by minidrivers that want to prevent removal of the device or by minidrivers that must disallow activity that would otherwise prevent them from committing to a device removal operation. If this routine is not provided, AVStream will assume that the device can commit to a removal. The routine is called at IRQL = PASSIVE_LEVEL and may not return STATUS_PENDING; a success code indicates that the device can commit to a removal and an error code indicates that it cannot. Return success if the device can be removed (or drivers can be updated) without disrupting the machine. This routine is optional.
IRP_MN_QUERY_STOP_DEVICE	The minidriver specifies a pointer to this routine in the QueryStop member of its KSDEVICE_DISPATCH structure. Use AVStrMiniQueryStop to prevent the stopping of the device or to disallow activity that would prevent the minidriver from committing to a stop operation. If this routine is not specified, AVStream assumes that the minidriver can commit to a stop operation. This routine is optional. Success indicates that the device can commit to a stop and an error code indicates that it cannot. Do not return STATUS_PENDING.
IRP_MN_QUERY_INTERFACE	A driver or system component sends this IRP to get information about an interface exported by your driver. For more information about the IRP, see IRP_MN_QUERY_INTERFACE. The minidriver specifies this routine's address in the QueryInterface member of its KSDEVICE_DISPATCH structure. This routine is optional.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ks.h (include Ks.h)
IRQL	PASSIVE_LEVEL (See Remarks section)