IHttpCoNtext：：CancelIo 方法

取消任何擱置的傳送或接收作業。

語法

virtual HRESULT CancelIo(  
   VOID  
) = 0;  

參數

此方法不會採用任何參數。

傳回值

HRESULT。 可能的值包括 (但不限於) 下表中的這些值。

值	描述
S_OK	表示作業成功。
ERROR_INVALID_HANDLE	表示 IIS 無法擷取和鎖定作業的非同步控制碼。

備註

方法會 CancelIo 終止 Web 用戶端的任何擱置傳送或接收作業。 例如，如果 HTTP 模組正在從 Web 用戶端讀取資訊，則呼叫 CancelIo 方法將會取消任何擱置的讀取作業。

這個方法與 IHttpResponse：：ResetConnection 和 IHttpResponse：：SetNeedDisconnect 方法不同，分別會分別重設與 Web 用戶端的通訊端連線或回應完成之後。

範例

下列程式碼範例示範如何使用 CancelIo 方法來建立 HTTP 模組，以取消任何擱置的傳送或接收作業。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Cancel any pending I/O operations.
        pHttpContext->CancelIo();
        
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_SEND_RESPONSE,
        0
    );
}

您的模組必須匯出 RegisterModule 函式。 您可以為專案建立模組定義 (.def) 檔案，或使用 參數編譯模組 /EXPORT:RegisterModule 來匯出此函式。 如需詳細資訊，請參閱 逐步解說：使用機器碼建立 Request-Level HTTP 模組。

您可以選擇性地使用呼叫慣例編譯器代碼， __stdcall (/Gz) 而不是明確宣告每個函式的呼叫慣例。

規格需求

類型	描述
Client	- Windows Vista 上的 IIS 7.0 - Windows 7 上的 IIS 7.5 - Windows 8 上的 IIS 8.0 - Windows 10上的 IIS 10.0
伺服器	- Windows Server 2008 上的 IIS 7.0 - Windows Server 2008 R2 上的 IIS 7.5 - Windows Server 2012 上的 IIS 8.0 - Windows Server 2012 R2 上的 IIS 8.5 - Windows Server 2016上的 IIS 10.0
產品	- IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0 - IIS Express 7.5、IIS Express 8.0、IIS Express 10.0
標頭	Httpserv.h

另請參閱

IHttpCoNtext 介面
IHttpResponse：：ResetConnection 方法
IHttpResponse：：SetNeedDisconnect 方法