IWinHttpRequest::SetCredentials メソッド

  • [アーティクル]

SetCredentials メソッドは、HTTP サーバーと共に使用する資格情報を、プロキシ サーバーまたは発信元サーバーのいずれであっても設定します。

構文

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

パラメーター

UserName [in]

認証のユーザー名を指定します。

パスワード [入力]

認証のパスワードを指定します。 bstrUserName が NULL または不足している場合、このパラメーターは無視されます。

Flags [in]

IWinHttpRequest が資格情報を使用するタイミングを指定します。 次のいずれかの値を指定できます。

値 説明
HTTPREQUEST_SETCREDENTIALS_FOR_SERVER
 資格情報はサーバーに渡されます。
HTTPREQUEST_SETCREDENTIALS_FOR_PROXY
 資格情報はプロキシに渡されます。

戻り値

戻り値は、成功した場合は S_OK 、それ以外の場合はエラー値です。

解説

Open の呼び出しが正常に完了しなかった場合、このメソッドはエラー値を返します。 ユーザーがセッションの資格情報を設定するには、プロキシ サーバーまたは配信元サーバーとの対話の何らかの尺度が必要であると想定されています。 さらに、サポートされている認証スキームがユーザーにわかるまでは、資格情報の書式を設定できません。

Note

Windows XP と Windows 2000 については、「WinHTTP スタート ページ」 の「ランタイム要件 」セクションを参照してください。

サーバーとプロキシの両方で認証するには、アプリケーションで SetCredentials を 2 回呼び出す必要があります。最初に 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 Professional SP3 [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server 2003、Windows 2000 Server SP3 [デスクトップ アプリのみ]
再頒布可能パッケージ
 Windows XP および Windows 2000 では、WinHTTP 5.0 およびインターネット エクスプローラー 5.01 以降がインストールされています。
IDL
HttpRequest.idl
ライブラリ
Winhttp.lib
[DLL]
Winhttp.dll

関連項目

IWinHttpRequest

WinHttpRequest

WinHTTP バージョン