IWinHttpRequest：：SetCredentials 方法
SetCredentials方法會設定要與 HTTP 伺服器搭配使用的認證，無論是 Proxy 伺服器還是原始伺服器。
語法
HRESULT SetCredentials(
[in] BSTR UserName,
[in] BSTR Password,
[in] HTTPREQUEST_SETCREDENTIALS_FLAGS Flags
);
參數
-
UserName [in]
-
指定驗證的使用者名稱。
-
密碼 [in]
-
指定驗證的密碼。 如果 bstrUserName 為 Null 或遺漏，則會忽略此參數。
-
旗標 [in]
-
指定 IWinHttpRequest 何時使用認證。 可以是下列其中一個值。
值 意義 - HTTPREQUEST_SETCREDENTIALS_FOR_SERVER
認證會傳遞至伺服器。 - HTTPREQUEST_SETCREDENTIALS_FOR_PROXY
認證會傳遞至 Proxy。
傳回值
傳回值會在成功或錯誤值時 S_OK 。否則為 。
備註
如果 呼叫 Open 尚未順利完成，這個方法會傳回錯誤值。 假設使用者必須先進行與 Proxy 伺服器或源伺服器的一些互動量值，使用者才能設定會話的認證。 此外，除非使用者知道支援的驗證配置 () ，否則無法格式化認證。
注意
針對 Windows XP 和 Windows 2000，請參閱 WinHTTP 起始頁的 執行時間需求 一節。
若要使用伺服器和 Proxy 進行驗證，應用程式必須呼叫 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 連線、設定伺服器的認證、使用 Proxy 的認證、傳送 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、具有 SP3 的 Windows 2000 Server [僅限傳統型應用程式] |
| 可轉散發套件 |
Windows XP 和 Windows 2000 上的 WinHTTP 5.0 和 Internet Explorer 5.01 或更新版本。 |
| Idl |
|
| 程式庫 |
|
| DLL |
|