IWinHttpRequest Interface (Windows)

IWinHttpRequest Interface

The IWinHttpRequest interface provides all of the nonevent methods for Microsoft Windows HTTP Services (WinHTTP).

The IWinHttpRequest interface inherits the methods of the IUnknown interface.

In addition, IWinHttpRequest defines the following methods.

Method	Description
SetProxy	Sets proxy server information.
SetCredentials	Sets credentials to be used with an HTTP server, either a proxy server or an originating server.
Open	Opens an HTTP connection to an HTTP resource.
SetRequestHeader	Adds, changes, or deletes an HTTP request header.
GetResponseHeader	Retrieves the HTTP response headers.
GetAllResponseHeaders	Retrieves all HTTP response headers.
Send	Sends an HTTP request to an HTTP server.
get_Status	Retrieves the HTTP status code from the last response.
get_StatusText	Retrieves the HTTP status text.
get_ResponseText	Retrieves the response entity body as text.
get_ResponseBody	Retrieves the response entity body as an array of unsigned bytes.
get_ResponseStream	Retrieves the response entity body as an IStream.
get_Option	Retrieves a WinHTTP option value.
put_Option	Sets a WinHTTP option value.
WaitForResponse	Waits for an asynchronous Send method to complete, with optional time-out value, in seconds.
Abort	Aborts a WinHTTP Send method.
SetTimeouts	Specifies the individual time-out components of a send/receive operation, in milliseconds.
SetClientCertificate	Selects a client certificate to send to a Secure Hypertext Transfer Protocol (HTTPS) server.
SetAutoLogonPolicy	Sets the current Automatic Logon Policy.

The IWinHttpRequest interface defines the following properties. The preceding table includes access methods for these properties.

Property	Access type	Description
Option	Read/write	A WinHTTP option value.
ResponseBody	Read-only	The response entity body as an array of unsigned bytes.
ResponseStream	Read-only	The response entity body as an IStream.
ResponseText	Read-only	The response entity body.
Status	Read-only	The HTTP status code from the last response.
StatusText	Read-only	The HTTP status text.

Note For Windows XP and Windows 2000, see the Run-Time Requirements section of the WinHttp start page.

Minimum supported client	Windows XP, Windows 2000 Professional with SP3
Minimum supported server	Windows Server 2003, Windows 2000 Server with SP3
Redistributable	WinHTTP 5.0 and Internet Explorer 5.01 or later on Windows XP and Windows 2000.
IDL	HttpRequest.idl
Library	Winhttp.lib
DLL	Winhttp.dll