PcUnregisterIoTimeout function (portcls.h)

Article
02/22/2024

The PcUnregisterIoTimeout function unregisters a driver-supplied I/O-timer callback routine for a specified device object.

Note This function is deprecated for Windows 8 and later versions of Windows. For Windows on Arm systems, this function is commented out in the PortCls class driver and is inaccessible.

Syntax

PORTCLASSAPI NTSTATUS PcUnregisterIoTimeout(
  [in] PDEVICE_OBJECT    pDeviceObject,
  [in] PIO_TIMER_ROUTINE pTimerRoutine,
  [in] PVOID             pContext
);

Parameters

[in] pDeviceObject

Pointer to the same device object that the driver supplied when it previously called PcRegisterIoTimeout. The device object is a system structure of type DEVICE_OBJECT.

[in] pTimerRoutine

Pointer to the same I/O-timer callback routine that the driver supplied when it previously called PcRegisterIoTimeout

[in] pContext

Pointer to the same driver-determined context that the driver supplied when it previously called PcRegisterIoTimeout

Return value

PcUnregisterIoTimeout returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code. The following table shows some of the possible error codes.

Return code	Description
STATUS_NOT_FOUND	Indicates that no timer callback with the same device object, callback routine, and context is currently registered.

Remarks

This call succeeds only if a time-out callback with the same device object, timer routine, and context was previously registered with a call to the PcRegisterIoTimeout function.

Requirements

Requirement	Value
Minimum supported client	The PortCls system driver implements the PcUnregisterIoTimeout function in Microsoft Windows 98/Me and in Windows 2000 and later operating systems.
Target Platform	Universal
Header	portcls.h (include Portcls.h)
Library	Portcls.lib
IRQL	PASSIVE_LEVEL