Compartilhar via


Método IBackgroundCopyJobHttpOptions::GetCustomHeaders (bits2_5.h)

Recupera os cabeçalhos personalizados definidos por uma chamada anterior para IBackgroundCopyJobHttpOptions::SetCustomHeaders (ou seja, cabeçalhos que o BITS enviará para o remoto, não cabeçalhos que o BITS recebe do remoto).

Sintaxe

HRESULT GetCustomHeaders(
  [out] LPWSTR *pRequestHeaders
);

Parâmetros

[out] pRequestHeaders

Cadeia de caracteres terminada em nulo que contém os cabeçalhos personalizados. Cada cabeçalho é encerrado por um caractere cr/LF (retorno de carro e alimentação de linha). Para liberar a cadeia de caracteres quando terminar, chame a função CoTaskMemFree .

Retornar valor

A tabela a seguir lista alguns dos valores retornados possíveis.

Código de retorno Descrição
S_OK
Os cabeçalhos foram recuperados com êxito.
S_FALSE
O trabalho não especifica cabeçalhos personalizados.
E_ACCESSDENIED
Você não tem permissão para recuperar os cabeçalhos personalizados ou [IBackgroundCopyJobHttpOptions3::MakeCustomHeadersWriteOnly](/windows/desktop/api/bits10_3/nf-bits10_3-ibackgroundcopyjobhttpoptions3-makecustomheaderswriteonly) foi chamado no trabalho.
RPC_X_NULL_REF_POINTER
O parâmetro pRequestHeaders é NULL.

Comentários

Somente o proprietário do trabalho pode recuperar os cabeçalhos personalizados. Para especificar os cabeçalhos, chame o método IBackgroundCopyJobHttpOptions::SetCustomHeaders .

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista
Servidor mínimo com suporte Windows Server 2008
Plataforma de Destino Windows
Cabeçalho bits2_5.h (inclua Bits.h)
Biblioteca Bits.lib

Confira também

IBackgroundCopyJobHttpOptions

IBackgroundCopyJobHttpOptions::SetCustomHeaders