IBackgroundCopyJobHttpOptions::GetClientCertificate 方法 (bits2_5.h)
從作業擷取客戶端憑證。
語法
HRESULT GetClientCertificate(
[out] BG_CERT_STORE_LOCATION *pStoreLocation,
[out] LPWSTR *pStoreName,
[out] byte **ppCertHashBlob,
[out] LPWSTR *pSubjectName
);
參數
[out] pStoreLocation
識別要用於查閱憑證的系統存放區位置。 如需可能的值,請參閱 BG_CERT_STORE_LOCATION 列舉。
[out] pStoreName
包含證書儲存名稱的 Null 終止字串。 若要在完成時釋放字串,請呼叫 CoTaskMemFree 函式。
[out] ppCertHashBlob
識別憑證的SHA1哈希。 若要在完成時釋放 Blob,請呼叫 CoTaskMemFree 函式。
[out] pSubjectName
Null 終止的字串,其中包含憑證的簡單主體名稱。 主體名稱中的 RDN 會以憑證顯示的順序相反。 如果憑證不包含主體名稱,則主體名稱可以是空的。 若要在完成時釋放字串,請呼叫 CoTaskMemFree 函式。
傳回值
下表列出一些可能的傳回值。
傳回碼 | Description |
---|---|
|
已成功擷取憑證。 |
|
作業未指定憑證,或用戶沒有憑證的許可權。 |
|
其中一個參數是 NULL。 |
備註
您可以使用 IBackgroundCopyJobHttpOptions::SetClientCertificateByID 或 IBackgroundCopyJobHttpOptions::SetClientCertificateByName 方法來指定憑證。
範例
下列範例示範如何擷取客戶端憑證的相關信息。 此範例假設 pJob 指向有效的作業。
#define THUMBPRINT_SIZE 20
HRESULT hr = S_OK;
IBackgroundCopyJob* pJob = NULL;
IBackgroundCopyJobHttpOptions* pHttpOptions = NULL;
GUID JobId;
BG_CERT_STORE_LOCATION StoreLocation;
LPWSTR pStoreName = NULL;
BYTE* pThumbprint = NULL;
LPWSTR pSubjectName = NULL;
// Retrieve a pointer to the IBackgroundCopyJobHttpOptions interface.
hr = pJob->QueryInterface(__uuidof(IBackgroundCopyJobHttpOptions), (void**)&pHttpOptions);
pJob->Release();
if (FAILED(hr))
{
wprintf(L"pJob->QueryInterface failed with 0x%x.\n", hr);
goto cleanup;
}
// Retrieve information about the client certificate set on the job.
hr = pHttpOptions->GetClientCertificate(&StoreLocation, &pStoreName,
&pThumbprint, &pSubjectName);
if (S_OK == hr)
{
wprintf(L"\nLocation: %d\nStore name: %s\nSubject: %s\n",
StoreLocation, pStoreName, pSubjectName);
wprintf(L"Thumbprint: ");
for (DWORD i = 0; i < THUMBPRINT_SIZE; i++)
{
wprintf(L"%x ", pThumbprint[i]);
}
wprintf(L"\n");
CoTaskMemFree(pStoreName);
CoTaskMemFree(pThumbprint);
CoTaskMemFree(pSubjectName);
}
else if (RPC_X_BAD_STUB_DATA == hr)
{
wprintf(L"The job does not specify a client certificate or\n"
L"the user does not have permission to access the certificate.\n");
}
else
{
wprintf(L"pHttpOptions->GetClientCertificate failed with 0x%x.\n", hr);
goto cleanup;
}
cleanup:
if (pHttpOptions)
{
hr = pHttpOptions->Release();
}
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista |
最低支援的伺服器 | Windows Server 2008 |
目標平台 | Windows |
標頭 | bits2_5.h (包含 Bits.h) |
程式庫 | Bits.lib |
另請參閱
IBackgroundCopyJobHttpOptions::RemoveClientCertificate