Метод IWinHttpRequest::SetCredentials

  • Статья

Метод SetCredentials задает учетные данные, используемые с HTTP-сервером, будь то прокси-сервер или исходный сервер.

Синтаксис

HRESULT SetCredentials(
  [in] BSTR                             UserName,
  [in] BSTR                             Password,
  [in] HTTPREQUEST_SETCREDENTIALS_FLAGS Flags
);

Параметры

UserName [in]

Указывает имя пользователя для проверки подлинности.

Пароль [вход]

Указывает пароль для проверки подлинности. Этот параметр игнорируется, если bstrUserName имеет значение NULL или отсутствует.

Флаги [в]

Указывает, когда IWinHttpRequest использует учетные данные. Может иметь одно из следующих значений.

Значение Значение
HTTPREQUEST_SETCREDENTIALS_FOR_SERVER
 Учетные данные передаются на сервер.
HTTPREQUEST_SETCREDENTIALS_FOR_PROXY
 Учетные данные передаются прокси-серверу.

Возвращаемое значение

Возвращаемое значение S_OK при успешном выполнении или значение ошибки в противном случае.

Комментарии

Этот метод возвращает значение ошибки, если вызов Open не завершился успешно. Предполагается, что определенная мера взаимодействия с прокси-сервером или сервером-источником должна произойти, прежде чем пользователи смогут задать учетные данные для сеанса. Кроме того, пока пользователи не узнают, какие схемы проверки подлинности поддерживаются, они не смогут форматировать учетные данные.

Примечание

Для Windows XP и Windows 2000 см. раздел Требования к времени выполнения начальной страницы WinHTTP.

Для проверки подлинности на сервере и прокси-сервере приложение должно дважды вызывать SetCredentials . Во-первых, параметру Flags присвоено значение HTTPREQUEST_SETCREDENTIALS_FOR_SERVER, а во-вторых, параметру Flags присвоено значение HTTPREQUEST_SETCREDENTIALS_FOR_PROXY.

Примеры

В следующем примере показано, как открыть HTTP-подключение, задать учетные данные для сервера, отправить HTTP-запрос и прочитать текст ответа. Этот пример должен выполняться из командной строки.

#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))
    {    // Set Credentials.
        BSTR bstrUserName = SysAllocString(L"User Name");
        BSTR bstrPassword = SysAllocString(L"Password");
        hr = pIWinHttpRequest->SetCredentials(
                               bstrUserName,
                               bstrPassword,
                               HTTPREQUEST_SETCREDENTIALS_FOR_SERVER);
        SysFreeString(bstrUserName);
        SysFreeString(bstrPassword);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Get Response text.
        hr = pIWinHttpRequest->get_ResponseText(&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;
}

В следующем примере скриптов показано, как открыть HTTP-подключение, задать учетные данные для сервера, задать учетные данные для прокси-сервера, если он используется, отправить HTTP-запрос и прочитать текст ответа.

// 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());

Требования

Требование Значение
Минимальная версия клиента
 Windows XP, Windows 2000 Профессиональная с пакетом обновления 3 (SP3) [только классические приложения]
Минимальная версия сервера
 Windows Server 2003, Windows 2000 Server с пакетом обновления 3 (SP3) [только классические приложения]
Распространяемые компоненты
 WinHTTP 5.0 и Internet Обозреватель 5.01 или более поздней версии в Windows XP и Windows 2000.
IDL
HttpRequest.idl
Библиотека
Winhttp.lib
DLL
Winhttp.dll

См. также раздел

IWinHttpRequest

WinHttpRequest

Версии WinHTTP