WinHTTP

https://learn.microsoft.com/en-us/windows/win32/winhttp/
Admin
WinHTTP is a Microsoft Windows HTTP client API that provides server-based applications with...
Tokens:143,414
Snippets:1,322
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### C++ example: open, send, and get all response headers

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-getallresponseheaders

Complete C++ example that initializes COM, creates a WinHttp.WinHttpRequest.5.1 object, opens a GET request to https://microsoft.com, sends it, retrieves all response headers with GetAllResponseHeaders, and prints the first 256 characters to the console. Run from a command prompt.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main(int argc, char* argv[])
{
    UNREFERENCED_PARAMETER(argc);
    UNREFERENCED_PARAMETER(argv);

    // Variable for return value
    HRESULT    hr;

    // Initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {    // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod, bstrUrl, varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Get Response text.
        hr = pIWinHttpRequest->GetAllResponseHeaders(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {    // Print the response to a console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}
```

--------------------------------

### C++ example: Get response header with IWinHttpRequest::GetResponseHeader

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-getresponseheader

C++ example that initializes COM, creates an IWinHttpRequest object, opens a GET request to https://microsoft.com, sends it, and retrieves the Date response header. Must be run from a command prompt. Requires the httprequest.h header and links ole32.lib and oleaut32.lib.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
    0x06f29373,
    0x5c5a,
    0x4b54,
    {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1",
                         &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid,
                              NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {
        // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod,
                                    bstrUrl,
                                    varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {
        // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {
        // Get Response text.
        BSTR bstrName = SysAllocString(L"Date");
        hr = pIWinHttpRequest->GetResponseHeader(bstrName,
                                             &bstrResponse);
    }
    if (SUCCEEDED(hr))
    {
        // Print response to console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}

```

--------------------------------

### C++ example: open, send, and read response with IWinHttpRequest

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-open

Complete C++ example that initializes COM, creates a WinHttp.WinHttpRequest.5.1 object, opens a synchronous GET request to https://microsoft.com, sends it, and prints the response text. Requires the httprequest.h header and links ole32.lib and oleaut32.lib. Uses the IID_IWinHttpRequest constant and frees all allocated BSTRs.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1",
                           &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid,
                              NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {
        // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod,
                                    bstrUrl,
                                    varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {
        // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {
        // Get Response text.
        hr = pIWinHttpRequest->get_ResponseText(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {
        // Print the response to a console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}
```

--------------------------------

### C++ example: open, send, and read response text

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-responsetext

C++ example that opens an HTTP connection, sends a GET request, and reads the response text using IWinHttpRequest. Must be run from a command prompt. It initializes COM, creates the WinHttp.WinHttpRequest.5.1 object, and prints the first 256 characters of the response.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM.
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {   // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod, bstrUrl, varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {   // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {   // Get Response text.
        hr = pIWinHttpRequest->get_ResponseText(&bstrResponse);
    }

    // Print the response to a console.
    wprintf(L"%.256s",bstrResponse);

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}
```

--------------------------------

### JScript example: get all response headers

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-getallresponseheaders

JScript scripting example that creates a WinHttpRequest object, opens a synchronous GET request to https://www.microsoft.com, sends it, and echoes all response headers returned by GetAllResponseHeaders.

```javascript
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Get all response headers.
WScript.Echo( WinHttpReq.GetAllResponseHeaders());
```

--------------------------------

### SetCredentials example: open HTTP connection, set server credentials, send request, read response

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-setcredentials

Use this example to see how to open an HTTP connection, set credentials for the server, send an HTTP request, and read the response text. The example must be run from a command prompt. It includes the necessary headers and links ole32.lib and oleaut32.lib, and defines the IID for IWinHttpRequest.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  { 0xbe, 0x68, 0x0d, 0x2e, 0x5e, 0x6d, 0x3c, 0x5a }
};

// Function to open an HTTP connection, set credentials for the server, send an HTTP request, and read the response text.
void SendRequest(LPCWSTR pwszServer, LPCWSTR pwszRealm, LPCWSTR pwszUser, LPCWSTR pwszPass, LPCWSTR pwszPath)
{
    IWinHttpRequest *pIRequest = NULL;    HRESULT hr;    BSTR bstrResponse = NULL;    VARIANT varFalse, varEmpty;    BOOL bRet = TRUE;    // Initialize COM.    hr = CoInitialize(NULL);    if (FAILED(hr))    {        printf(
```

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  { 0xbd, 0x4e, 0x37, 0x61, 0x61, 0x6f, 0x48, 0xf2 }
};

int main()
{
    // variable for return value
    HRESULT  hr;                 // return value for all calls except WinHttpOpen and WinHttpConnect.  These return HINTERNET handles.  See WinHttpOpen and WinHttpConnect for more information.  hr = S_OK;    // variable for the result of the WinHttpOpen call.    HINTERNET hHttp = NULL;    // variable for the result of the WinHttpConnect call.    HINTERNET hConnect = NULL;    // variable for the result of the WinHttpOpenRequest call.    HINTERNET hRequest = NULL;    // variable for the result of the WinHttpSendRequest call.    BOOL bResults = FALSE;    // variable for the result of the WinHttpReceiveResponse call.    BOOL bResponse = FALSE;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwSize = 0;    // variable for the result of the WinHttpReadData call.    DWORD dwDownloaded = 0;    // variable for the result of the WinHttpQueryHeaders call.    DWORD dwHeaderSize = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwDataSize = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwTotalSize = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesWritten = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesWritten = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToWrite = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesToRead = 0;    // variable for the result of the WinHttpQueryDataAvailable call.    DWORD dwBytesTo
```

--------------------------------

### Set and view WinHTTP options in C++ (IWinHttpRequest)

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-option

C++ example that creates a WinHttpRequest object, opens a GET request to https://microsoft.com, sets the user agent string via put_Option with WinHttpRequestOption_UserAgentString, sends the request, and then retrieves and prints the user agent, URL, URL code page, and escape-percent option values. Requires COM initialization and linking ole32.lib and oleaut32.lib.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
    0x06f29373,
    0x5c5a,
    0x4b54,
    {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;
    VARIANT         varUserAgent;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    varUserAgent.vt = VT_BSTR;
    varUserAgent.bstrVal = NULL;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid,
                              NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {
        // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod,
                                    bstrUrl,
                                    varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {
        // Specify the user agent.
        varUserAgent.vt = VT_BSTR;
        varUserAgent.bstrVal =
                   SysAllocString(
                           L"A WinHttpRequest Example Program");

        //varUserAgent is L"A WinHttpRequest Example Program");
        hr = pIWinHttpRequest->put_Option(
                                 WinHttpRequestOption_UserAgentString,
                                 varUserAgent);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {
        // Get user agent string.
        hr = pIWinHttpRequest->get_Option(
                                 WinHttpRequestOption_UserAgentString,
                                 &varUserAgent);
        // Print response to console.
        wprintf(L"%s\n\n", varUserAgent.bstrVal);

        // Get URL.
        hr = pIWinHttpRequest->get_Option(WinHttpRequestOption_URL,
                                          &varUserAgent);
        // Print response to console.
        wprintf(L"%s\n\n", varUserAgent.bstrVal);

        // Get URL Code Page.
        hr = pIWinHttpRequest->get_Option(
                                     WinHttpRequestOption_URLCodePage,
                                     &varUserAgent);
        // Print response to console.
        wprintf(L"%u\n\n", varUserAgent.lVal);

        // Convert percent symbols to escape sequences.
        hr = pIWinHttpRequest->get_Option(
                              WinHttpRequestOption_EscapePercentInURL,
                              &varUserAgent);
        // Print response to console.
        wprintf(L"%s\n", varUserAgent.boolVal?L"True":L"False");
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);
    if (varUserAgent.bstrVal)
        SysFreeString(varUserAgent.bstrVal);

    CoUninitialize();
    return 0;
}

```

--------------------------------

### JScript example: Get response header with WinHttpRequest

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-getresponseheader

JScript example that creates a WinHttpRequest object, opens a GET request to https://www.microsoft.com, sends it, and displays the Date response header using WScript.Echo.

```javascript
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", 
                "https://www.microsoft.com", 
                 false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Display the date header.
WScript.Echo( WinHttpReq.GetResponseHeader("Date"));

```

--------------------------------

### JScript example: open, send, and read response with WinHttpRequest

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-open

JScript scripting example that creates a WinHttpRequest object, opens a synchronous GET request to https://www.microsoft.com, sends it, and echoes the response text. The false argument to Open selects synchronous mode.

```javascript
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Display the response text.
WScript.Echo( WinHttpReq.ResponseText);
```

--------------------------------

### C++ example: Open asynchronous HTTP connection, send request, wait for response, and read response text

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-waitforresponse

This C++ example demonstrates using IWinHttpRequest::WaitForResponse in a console application. It initializes COM, creates an IWinHttpRequest instance, opens an asynchronous GET request to https://microsoft.com, sends it, waits for the response, and prints the response text. The example includes necessary includes, IID definition, and cleanup of COM objects and BSTRs.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM.
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varTrue;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varTrue);
    V_VT(&varTrue)   = VT_BOOL;
    V_BOOL(&varTrue) = VARIANT_TRUE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {    // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod, bstrUrl, varTrue);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Wait for response.
        VARIANT_BOOL varResult;
        hr = pIWinHttpRequest->WaitForResponse(varEmpty, &varResult);
    }
    if (SUCCEEDED(hr))
    {    // Get Response text.
        hr = pIWinHttpRequest->get_ResponseText(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {    // Print the response to a console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}

```

--------------------------------

### C++ Example: Open, Send, and Display Status

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-status

C++ example that opens an HTTP connection, sends a request, displays the Status and StatusText, and reads the response headers. Must be run from a command prompt. Uses the IWinHttpRequest interface and requires COM initialization.

```cpp
#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // variable for return value
    HRESULT    hr;

    // initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;
    LONG            lStatus = 0;
    BSTR            bstrStatusText = NULL;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {    // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod, bstrUrl,
                                    varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->get_Status(&lStatus);
        hr = pIWinHttpRequest->get_StatusText(&bstrStatusText);
    }
    if (SUCCEEDED(hr))
    {    // Get Response text.
        hr = pIWinHttpRequest->GetAllResponseHeaders(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {    // Print response to console.
        wprintf(L"%s\n\n", bstrResponse);
        wprintf(L"%u - %s\n\n", lStatus, bstrStatusText);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrStatusText)
        SysFreeString(bstrStatusText);
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}

```

--------------------------------

### JScript example: open, send, display Status and StatusText

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-statustext

Opens an HTTP connection, sends a GET request, displays Status and StatusText, and prints response headers.

```JScript
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Display the status.
WScript.Echo( WinHttpReq.Status + " - " + WinHttpReq.StatusText);

// Display the date header.
WScript.Echo( WinHttpReq.GetAllResponseHeaders());


```

--------------------------------

### dnsResolveEx example

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/dnsresolveex

Example call to dnsResolveEx with the host 'testmachine1', showing the returned semi-colon delimited string of IPv6 and IPv4 addresses.

```plaintext
dnsResolveEx("testmachine1");
    returns the string "fe80::380c:2e71:f5b9:a3b5%15;fe80::982d:a3b3:97ad:7dd0%9;2001:4898:28:7:982d:a3b3:97ad:7dd0;2001:4898:28:7:adfe:a643:8130:2fdc;fe80::5efe:10.70.92.74%13;3ffe:8311:ffff:f70f:0:5efe:10.70.92.74;10.70.92.74;3ffe:831f:4136:e37e:380c:2e71"
```

--------------------------------

### Example: Updating the interface index table for Wi-Fi and cellular connections

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/winhttpconnectionupdateifindextable

Shows how to populate a WINHTTP_CONNECTION_IFINDEX_LIST with entries for Wi-Fi and cellular connections and call WinHttpConnectionUpdateIfIndexTable. The example assumes hSession is a valid session handle. Note that this API is not currently included in an SDK header file, so you must declare the function yourself.

```cpp
WINHTTP_CONNECTION_IFINDEX_ENTRY entries[2] = {};
entries[0].pwszConnectionName = L"Wi-Fi";
entries[0].dwIfIndex = 4;
entries[1].pwszConnectionName = L"Cellular";
entries[1].dwIfIndex = 7;

WINHTTP_CONNECTION_IFINDEX_LIST ifList = {};
ifList.pConnectionIfIndexEntries = entries;
ifList.nEntries = 2;

WinHttpConnectionUpdateIfIndexTable(hSession, &ifList);
```

--------------------------------

### Set and view WinHTTP options in JScript (WinHttpRequest.Option)

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-option

JScript example that defines the WinHttpRequestOption_* constants, creates a WinHttpRequest object via ActiveXObject, opens a synchronous GET request to https://www.microsoft.com, sends it, and then uses the Option property to display the user agent, URL, code page, and escape-percent values with WScript.Echo.

```javascript
// Define the constants used by the option property.
WinHttpRequestOption_UserAgentString = 0;    // Name of the user agent
WinHttpRequestOption_URL = 1;                // Current URL
WinHttpRequestOption_URLCodePage = 2;        // Code page
WinHttpRequestOption_EscapePercentInURL = 3; // Convert percents 
                                             // in the URL

// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Display the WinHTTP option values.
WScript.Echo( 'User agent:      '+
             WinHttpReq.Option(WinHttpRequestOption_UserAgentString));
WScript.Echo( 'URL:             '+
             WinHttpReq.Option(WinHttpRequestOption_URL));
WScript.Echo( 'Code page:       '+
             WinHttpReq.Option(WinHttpRequestOption_URLCodePage));
WScript.Echo( 'Escape percents: '+
          WinHttpReq.Option(WinHttpRequestOption_EscapePercentInURL));

```

--------------------------------

### JScript Example: Open, Send, and Display Status

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-status

JScript example that opens an HTTP connection, sends a request, displays the Status and StatusText, and reads the response text. Uses the WinHttp.WinHttpRequest.5.1 ActiveX object.

```javascript
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send(); 

// Display the status.
WScript.Echo( WinHttpReq.Status + " - " + WinHttpReq.StatusText);

// Display the date header.
WScript.Echo( WinHttpReq.GetAllResponseHeaders());

```

--------------------------------

### sortIpAddressList example with input and output

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/sortipaddresslist

Example call to sortIpAddressList with a semi-colon delimited list of IP addresses. The output shows the sorted list, with IPv6 addresses first followed by IPv4 addresses.

```plaintext
sortIpAddressList(2001:4898:28:3:201:2ff:feea:fc14; 
                  157.59.139.22; 
                  fe80::5efe:157.59.139.22");
    returns "fe80::5efe:157.59.139.22;2001:4898:28:3:201:2ff:feea:fc14;157.59.139.22" 
    A list of sorted IP addresses. If there both IPv6 and IPv4 IP addresses are passed as input to this function, then the sorted IPv6 addresses are followed by sorted IPv4 addresses
```

--------------------------------

### set proxy examples for WinHTTP proxy configuration

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/netsh-exe-commands

Deprecated `set proxy` command examples for configuring the WinHTTP proxy setting. The first sets a proxy server, the second adds a bypass list with `<local>` to bypass short name hosts, and the third specifies different proxies for http and https protocols with a bypass list. Use `set advproxy` instead.

```powershell
set proxy myproxy

set proxy myproxy:80 "<local>bar"

set proxy proxy-server="http=myproxy;https=sproxy:88" bypass-list="*.contoso.com"

```

--------------------------------

### JScript example: SetCredentials for server and proxy

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/iwinhttprequest-setcredentials

This example creates a WinHttpRequest object, opens a URL, and sends a request. It handles 401 (server authentication) and 407 (proxy authentication) status codes by calling SetCredentials with the appropriate flag. The loop aborts if the same status code repeats, and finally displays the status and response headers.

```JScript
// HttpRequest SetCredentials flags
HTTPREQUEST_SETCREDENTIALS_FOR_SERVER = 0;
HTTPREQUEST_SETCREDENTIALS_FOR_PROXY = 1;

// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Specify the target resource.
var targURL = "https://msdn.microsoft.com/downloads/samples/"+
              "internet/winhttp/auth/authenticate.asp";    
WinHttpReq.open("GET", targURL, false);

var Done = false;
var LastStatus=0;
do {
    // Send a request to the server and wait for a response.                               
    WinHttpReq.send(); 
    
    // Obtain the status code from the response.
    var Status = WinHttpReq.Status;

    switch (Status){
        // A 200 status indicates that the resource was retrieved.
        case 200:
            Done = true;
            break;
                
        // A 401 status indicates that the server 
        // requires authentication.    
        case 401:
            WScript.Echo("Requires Server UserName and Password.");

            // Specify the target resource.
            WinHttpReq.open("GET", targURL, false);
                            
            // Set credentials for the server.
            WinHttpReq.SetCredentials("User Name", "Password", 
                        HTTPREQUEST_SETCREDENTIALS_FOR_SERVER);

            // If the same credentials are requested twice, abort 
            // the request.  For simplicity, this sample does not 
            // check for a repeated sequence of status codes.
            if (LastStatus==401)
                Done = true;
            break;

        // A 407 status indicates that the proxy 
        // requires authentication.    
        case 407:
            WScript.Echo("Requires Proxy UserName and Password.");
                
            // Specify the target resource.
            WinHttpReq.open("GET", targURL, false);
    
            // Set credentials for the proxy.
            WinHttpReq.SetCredentials("User Name", "Password", 
                HTTPREQUEST_SETCREDENTIALS_FOR_PROXY);

            // If the same credentials are requested twice, abort 
            // the request.  For simplicity, this sample does not 
            // check for a repeated sequence of status codes.
            if (LastStatus==407)
                Done = true;
            break;
        
        // Any other status is unexpected.
        default:
            WScript.Echo("Unexpected Status: "+Status);
            Done = true;
            break;
    }
    
    // Keep track of the last status code.
    LastStatus = Status;
    
} while (!Done);

// Display the results of the request.
WScript.Echo(WinHttpReq.Status + "   " + WinHttpReq.StatusText);
WScript.Echo(WinHttpReq.GetAllResponseHeaders());

```

--------------------------------

### WINHTTP_OPTION_TLS_FALSE_START

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/option-flags

Enables TLS False Start for the connection.

```APIDOC
## WINHTTP_OPTION_TLS_FALSE_START

### Description
Enables TLS False Start for the connection.

### Option
WINHTTP_OPTION_TLS_FALSE_START

### Parameters
None explicitly documented.
```

--------------------------------

### WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/option-flags

Instructs the stack to start a WebSocket handshake process with WinHttpSendRequest.

```APIDOC
## WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET

### Description
Instructs the stack to start a WebSocket handshake process with WinHttpSendRequest. This option takes no parameters.

### Option
WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET

### Parameters
None.
```

--------------------------------

### set tracing examples for WinHTTP tracing parameters

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/netsh-exe-commands

Examples of the `set tracing` command for configuring WinHTTP tracing parameters. The first sets a trace file prefix, verbose level, and hex format. The second routes tracing to a debugger with a maximum file size of 512000 bytes and enables tracing.

```powershell
set tracing trace-file-prefix="C:\Temp\Test3" level=verbose format=hex

set tracing output=debugger max-trace-file-size=512000 state=enabled

```

--------------------------------

### Example: Delete and set connection manager policy entries

Source: https://learn.microsoft.com/en-us/windows/win32/winhttp/winhttpconnectionsetpolicyentries

Deletes existing connection manager policy entries and then registers a new on-demand policy for all apps connecting to hosts matching *.contoso.com. The example uses TAG_WINHTTP_CONNECTION_POLICY_TAG_WWWPT for both operations. Note that this API is not currently included in an SDK header file, so you must declare the function yourself.

```cpp
// First delete existing connection manager policies
WinHttpConnectionDeletePolicyEntries(
    hSession,
    TAG_WINHTTP_CONNECTION_POLICY_TAG_WWWPT);

// Then set new policies
WINHTTP_CONNECTION_POLICY_ENTRY entry = {};
entry.pwszHost = L"*.contoso.com";
entry.pwszAppId = L"*";

PCWSTR connectionName = L"Contoso Cellular";
entry.nConnections = 1;
entry.ppwszConnections = &connectionName;

WINHTTP_CONNECTION_POLICY_ENTRY_LIST list = {};
list.pPolicyEntries = &entry;
list.nEntries = 1;

WinHttpConnectionSetPolicyEntries(
    hSession,
    TAG_WINHTTP_CONNECTION_POLICY_TAG_WWWPT,
    &list);
```
Tokens:
Raw