WinHttpReceiveResponse 函数 (winhttp.h)

WinHttpReceiveResponse 函数等待接收 WinHttpSendRequest 发起的 HTTP 请求的响应。 WinHttpReceiveResponse 成功完成后,已收到状态代码和响应标头,可供应用程序使用 WinHttpQueryHeaders 进行检查。 应用程序必须先调用 WinHttpReceiveResponse ,然后才能使用 WinHttpQueryDataAvailableWinHttpReadData 访问响应实体正文 ((如果有任何) )。

语法

WINHTTPAPI BOOL WinHttpReceiveResponse(
  [in] HINTERNET hRequest,
  [in] LPVOID    lpReserved
);

参数

[in] hRequest

WINHttpOpenRequest 返回并由 WinHttpSendRequest 发送的 HINTERNET 句柄。 等待 WinHttpSendRequest 完成此句柄,然后再调用 WinHttpReceiveResponse

[in] lpReserved

此参数是保留的,必须为 NULL

返回值

如果成功,则返回 TRUE ,否则返回 FALSE 。 有关扩展的错误信息,请调用 GetLastError。 返回的错误代码如下。

错误代码 说明
ERROR_WINHTTP_CANNOT_CONNECT
如果与服务器的连接失败,则返回 。
ERROR_WINHTTP_CHUNKED_ENCODING_HEADER_SIZE_OVERFLOW
在分析分块编码过程中遇到溢出条件时返回。
ERROR_WINHTTP_CLIENT_AUTH_CERT_NEEDED
服务器请求客户端身份验证时返回。
ERROR_WINHTTP_CONNECTION_ERROR
与服务器的连接已重置或终止,或者遇到不兼容的 SSL 协议。 例如,WinHTTP 版本 5.1 不支持 SSL2,除非客户端专门启用 SSL2。
ERROR_WINHTTP_HEADER_COUNT_EXCEEDED
当响应中存在的标头数超过 WinHTTP 可以接收的标头数时返回。
ERROR_WINHTTP_HEADER_SIZE_OVERFLOW
当收到的标头的大小超过请求句柄的限制时, WinHttpReceiveResponse 返回。
ERROR_WINHTTP_INCORRECT_HANDLE_STATE
无法执行请求的操作,因为提供的句柄未处于正确的状态。
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE
此操作提供的句柄类型不正确。
ERROR_WINHTTP_INTERNAL_ERROR
发生了内部错误。
ERROR_WINHTTP_INVALID_SERVER_RESPONSE
无法分析服务器响应。
ERROR_WINHTTP_INVALID_URL
URL 无效。
ERROR_WINHTTP_LOGIN_FAILURE
登录尝试失败。 遇到此错误时,应使用 WinHttpCloseHandle 关闭请求句柄。 在重试最初生成此错误的函数之前,必须创建新的请求句柄。
ERROR_WINHTTP_NAME_NOT_RESOLVED
无法解析服务器名称。
ERROR_WINHTTP_OPERATION_CANCELLED
操作被取消,通常是因为操作之前关闭了操作请求的句柄。
ERROR_WINHTTP_REDIRECT_FAILED
重定向失败,因为方案已更改,或者所有重定向尝试都失败, (默认为五次尝试) 。
ERROR_WINHTTP_RESEND_REQUEST
WinHTTP 函数失败。 可以在同一请求句柄上重试所需的函数。
ERROR_WINHTTP_RESPONSE_DRAIN_OVERFLOW
当传入响应超过内部 WinHTTP 大小限制时返回。
ERROR_WINHTTP_SECURE_FAILURE
在服务器发送的安全套接字层 (SSL) 证书中发现一个或多个错误。 若要确定遇到的错误类型,检查状态回调函数中的WINHTTP_CALLBACK_STATUS_SECURE_FAILURE通知。 有关详细信息,请参阅 WINHTTP_STATUS_CALLBACK
ERROR_WINHTTP_TIMEOUT
请求已超时。
ERROR_WINHTTP_UNRECOGNIZED_SCHEME
URL 指定了“http:”或“https:”以外的方案。
ERROR_NOT_ENOUGH_MEMORY
内存不足,无法完成请求的操作。 (Windows 错误代码)

注解

即使在异步模式下使用 WinHTTP, (即在 WinHttpOpen) 中设置了WINHTTP_FLAG_ASYNC,此函数也可以同步或异步运行。 如果此函数返回 FALSE,则此函数失败,你可以调用 GetLastError 来获取扩展的错误信息。 如果此函数返回 TRUE,则应用程序应预期 WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE 完成回调(指示成功)或 WINHTTP_CALLBACK_STATUS_REQUEST_ERROR 完成回调(指示操作异步完成但失败)。

如果状态回调函数已随 WinHttpSetStatusCallback 一起安装,则在 WinHttpSetStatusCallbackdwNotificationFlags 参数中设置的以下通知指示接收响应的进度:

  • WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE
  • WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED
  • WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE
  • WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE
  • WINHTTP_CALLBACK_STATUS_REDIRECT
如果服务器关闭连接,则还会报告以下通知,前提是已在 WinHttpSetStatusCallbackdwNotificationFlags 参数中设置这些通知:
  • WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION
  • WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED
注意 对于 Windows XP 和 Windows 2000,请参阅 WinHttp 起始页的 运行时要求 部分。
 

示例

此示例演示将数据写入 HTTP 服务器的代码。 示例中提供的服务器名称 (www.wingtiptoys.com)是虚构的,必须替换为你对其具有写入访问权限的服务器的名称。

    LPSTR pszData = "WinHttpWriteData Example";
    DWORD dwBytesWritten = 0;
    BOOL  bResults = FALSE;
    HINTERNET hSession = NULL,
              hConnect = NULL,
              hRequest = NULL;

    // Use WinHttpOpen to obtain a session handle.
    hSession = WinHttpOpen(  L"A WinHTTP Example Program/1.0", 
                             WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
                             WINHTTP_NO_PROXY_NAME, 
                             WINHTTP_NO_PROXY_BYPASS, 0);

    // Specify an HTTP server.
    if (hSession)
        hConnect = WinHttpConnect( hSession, L"www.wingtiptoys.com",
                                   INTERNET_DEFAULT_HTTP_PORT, 0);

    // Create an HTTP Request handle.
    if (hConnect)
        hRequest = WinHttpOpenRequest( hConnect, L"PUT", 
                                       L"/writetst.txt", 
                                       NULL, WINHTTP_NO_REFERER, 
                                       WINHTTP_DEFAULT_ACCEPT_TYPES, 
                                       0);

    // Send a Request.
    if (hRequest) 
        bResults = WinHttpSendRequest( hRequest, 
                                       WINHTTP_NO_ADDITIONAL_HEADERS,
                                       0, WINHTTP_NO_REQUEST_DATA, 0, 
                                       (DWORD)strlen(pszData), 0);

    // Write data to the server.
    if (bResults)
        bResults = WinHttpWriteData( hRequest, pszData, 
                                     (DWORD)strlen(pszData), 
                                     &dwBytesWritten);

    // End the request.
    if (bResults)
        bResults = WinHttpReceiveResponse( hRequest, NULL);

    // Report any errors.
    if (!bResults)
        printf("Error %d has occurred.\n",GetLastError());


    // Close any open handles.
    if (hRequest) WinHttpCloseHandle(hRequest);
    if (hConnect) WinHttpCloseHandle(hConnect);
    if (hSession) WinHttpCloseHandle(hSession);

要求

要求
最低受支持的客户端 Windows XP、Windows 2000 Professional SP3 [仅限桌面应用]
最低受支持的服务器 Windows Server 2003、Windows 2000 Server SP3 [仅限桌面应用]
目标平台 Windows
标头 winhttp.h
Library Winhttp.lib
DLL Winhttp.dll
可再发行组件 Windows XP 和 Windows 2000 上的 WinHTTP 5.0 和 Internet Explorer 5.01 或更高版本。

另请参阅

关于 Microsoft Windows HTTP Services (WinHTTP)

WinHTTP 版本

WinHttpCloseHandle

WinHttpOpen

WinHttpOpenRequest

WinHttpSendRequest