检索先前调用 IBackgroundCopyJobHttpOptions::SetCustomHeaders (即 BITS 将发送到远程的标头,而不是 BITS 从远程接收的标头)设置的自定义标头。
Syntax
HRESULT GetCustomHeaders(
[out] LPWSTR *pRequestHeaders
);
参数
[out] pRequestHeaders
包含自定义标头的以 Null 结尾的字符串。 每个标头由回车符和换行符(CR/LF)字符终止。 若要在完成后释放字符串,请调用 CoTaskMemFree 函数。
返回值
下表列出了一些可能的返回值。
| 返回代码 | Description |
|---|---|
|
已成功检索标头。 |
|
作业未指定自定义标头。 |
|
您没有检索自定义标头的权限,或者 [IBackgroundCopyJobHttpOptions3::MakeCustomHeadersWriteOnly](/windows/desktop/api/bits10_3/nf-bits10_3-ibackgroundcopyjobhttpoptions3-makecustomheaderswriteonly)已在作业上调用。 |
|
pRequestHeaders 参数为 NULL。 |
注解
只有作业所有者才能检索自定义标头。 若要指定标头,请调用 IBackgroundCopyJobHttpOptions::SetCustomHeaders 方法。
要求
| Requirement | 价值 |
|---|---|
| 最低支持的客户端 | Windows Vista |
| 支持的最低服务器 | Windows Server 2008 |
| 目标平台 | Windows操作系统 |
| Header | bits2_5.h (包括 Bits.h) |
| Library | Bits.lib |