Expand Minimize

CancelThreadpoolIo function

Cancels the notification from the StartThreadpoolIo function.

Syntax


VOID WINAPI CancelThreadpoolIo(
  _Inout_  PTP_IO pio
);

Parameters

pio [in, out]

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 only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinBase.h on Windows Vista, Windows 7, Windows Server 2008, and Windows Server 2008 R2 (include Windows.h);
Threadpoolapiset.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CloseThreadpoolIo
CreateThreadpoolIo
StartThreadpoolIo
Thread Pools
WaitForThreadpoolIoCallbacks

 

 

Community Additions

ADD
Show:
© 2014 Microsoft