Edit

Share via

IBackgroundCopyJobHttpOptions3::MakeCustomHeadersWriteOnly method (bits10_3.h)

  • Article

Sets the HTTP custom headers for this job to be write-only. Write-only headers cannot be read by BITS methods such as the IBackgroundCopyJobHttpOptions::GetCustomHeaders method.

Syntax

HRESULT MakeCustomHeadersWriteOnly();

Return value

The return value is always S_OK.

Remarks

Use this API when your BITS custom headers must include security information (such as an API token) that you don't want to be readable by other programs running on the same computer. The BITS process, of course, can still read these headers, and send them over the HTTP connection. Once the headers are set to write-only, that cannot be unset.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Header bits10_3.h (include Bits.h)
Library Bits.lib
DLL Bits.dll