CancelThreadpoolIo function (threadpoolapiset.h)

Cancels the notification from the StartThreadpoolIo function.

Syntax

VOID CancelThreadpoolIo(
 [in, out] PTP_IO pio
);

Parameters

[in, out] pio

A pointer to a TP_IO structure that defines the I/O completion object. The CreateThreadpoolIo function returns this pointer.

Return value

None

Remarks

To prevent memory leaks, you must call the CancelThreadpoolIo function for either of the following scenarios:

• An overlapped (asynchronous) I/O operation fails (that is, the asynchronous I/O function call returns failure with an error code other than ERROR_IO_PENDING).
• An asynchronous I/O operation returns immediately with success and the file handle associated with the I/O completion object has the notification mode FILE_SKIP_COMPLETION_PORT_ON_SUCCESS. The file handle will not notify the I/O completion port and the associated I/O callback function will not be called.

Requirements

See also

CloseThreadpoolIo

CreateThreadpoolIo

StartThreadpoolIo

Thread Pools

WaitForThreadpoolIoCallbacks