Função HttpSetRequestProperty (http.h)

Artigo
08/24/2023

A função HttpSetRequestProperty define uma nova propriedade ou modifica uma propriedade existente na solicitação especificada.

Sintaxe

HTTPAPI_LINKAGE ULONG HttpSetRequestProperty(
  [in] HANDLE                RequestQueueHandle,
  [in] HTTP_OPAQUE_ID        Id,
  [in] HTTP_REQUEST_PROPERTY PropertyId,
  [in] PVOID                 Input,
  [in] ULONG                 InputPropertySize,
  [in] LPOVERLAPPED          Overlapped
);

Parâmetros

[in] RequestQueueHandle

O identificador para a fila de solicitação na qual a solicitação foi recebida. Uma fila de solicitação é criada e seu identificador retornado por uma chamada para a função HttpCreateRequestQueue .

[in] Id

A ID opaca da solicitação. Essa ID está localizada no membro RequestId da estrutura HTTP_REQUEST retornada por HttpReceiveHttpRequest.

[in] PropertyId

Um membro da enumeração HTTP_REQUEST_PROPERTY que descreve o tipo de propriedade definido. Este deve ser um dos seguintes:

[in] Input

Um ponteiro para o buffer que contém as informações da propriedade.

Ele deve apontar para um dos seguintes tipos de informações de propriedade com base na propriedade definida.

[in] InputPropertySize

O comprimento, em bytes, do buffer apontado pelo parâmetro Input .

[in] Overlapped

Para chamadas assíncronas, defina pOverlapped para apontar para uma estrutura OVERLAPPED ; para chamadas síncronas, defina-a como NULL.

Uma chamada síncrona bloqueia até que a operação seja concluída, enquanto uma chamada assíncrona retorna imediatamente ERROR_IO_PENDING e o aplicativo de chamada usa as portas de conclusão GetOverlappedResult ou de E/S para determinar quando a operação é concluída. Para obter mais informações sobre como usar estruturas OVERLAPPED para sincronização, consulte Sincronização e entrada e saída sobrepostas.

Valor retornado

Se a função for bem-sucedida, ela retornará ERROR_SUCCESS.

Se a função falhar, ela retornará um código de erro do sistema.

Requisitos


Plataforma de Destino	Windows
Cabeçalho	http.h
Biblioteca	Httpapi.lib
DLL	Httpapi.dll

Confira também

HttpSetRequestQueueProperty

Compartilhar via