KSDEVICE_DISPATCH structure (ks.h)

The KSDEVICE_DISPATCH structure describes the callbacks that a client can provide to receive notification of device creation and PnP events.

Syntax

typedef struct _KSDEVICE_DISPATCH {
  PFNKSDEVICECREATE            Add;
  PFNKSDEVICEPNPSTART          Start;
  PFNKSDEVICE                  PostStart;
  PFNKSDEVICEIRP               QueryStop;
  PFNKSDEVICEIRPVOID           CancelStop;
  PFNKSDEVICEIRPVOID           Stop;
  PFNKSDEVICEIRP               QueryRemove;
  PFNKSDEVICEIRPVOID           CancelRemove;
  PFNKSDEVICEIRPVOID           Remove;
  PFNKSDEVICEQUERYCAPABILITIES QueryCapabilities;
  PFNKSDEVICEIRPVOID           SurpriseRemoval;
  PFNKSDEVICEQUERYPOWER        QueryPower;
  PFNKSDEVICESETPOWER          SetPower;
  PFNKSDEVICEIRP               QueryInterface;
} KSDEVICE_DISPATCH, *PKSDEVICE_DISPATCH;

Members

Add

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceAdd callback routine.

Start

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceStart callback routine.

PostStart

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDevicePostStart callback routine.

QueryStop

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceQueryStop callback routine.

CancelStop

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceCancelStop callback routine.

Stop

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceStop callback routine.

QueryRemove

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceQueryRemove callback routine.

CancelRemove

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceCancelRemove callback routine.

Remove

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceRemove callback routine.

QueryCapabilities

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceQueryCapabilities callback routine.

SurpriseRemoval

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceSurpriseRemoval callback routine.

QueryPower

Optional. can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceQueryPower callback routine.

SetPower

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceSetPower callback routine.

QueryInterface

Optional. Can be NULL. A pointer to a minidriver-supplied AVStrMiniDeviceQueryInterface callback routine.

Remarks

In describing a device with the KSDEVICE_DESCRIPTOR structure, clients include a pointer to a dispatch table defined by this structure. Any member of this structure may be NULL indicating that the minidriver receives no notification for that particular message.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and in Microsoft DirectX 8.0 and later versions.
Header	ks.h (include Ks.h)

See also

KSDEVICE_DESCRIPTOR