CancelThreadpoolIo function

Cancels the notification from the StartThreadpoolIo function.

Syntax

void CancelThreadpoolIo(
  PTP_IO pio
);

Parameters

pio

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

Return Value

This function does not return a value.

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.
To compile an application that uses this function, define _WIN32_WINNT as 0x0600 or higher.

Requirements

   
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header threadpoolapiset.h (include Windows 7, Windows Server 2008 Windows Server 2008 R2, Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

CloseThreadpoolIo

CreateThreadpoolIo

StartThreadpoolIo

Thread Pools

WaitForThreadpoolIoCallbacks