Edit

HttpSetRequestProperty function (http.h)

  • Article

The HttpSetRequestProperty function sets a new property or modifies an existing property on the specified request.

Syntax

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
);

Parameters

[in] RequestQueueHandle

The handle to the request queue on which the request was received. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function.

[in] Id

The opaque ID of the request. This ID is located in the RequestId member of the HTTP_REQUEST structure returned by HttpReceiveHttpRequest.

[in] PropertyId

A member of the HTTP_REQUEST_PROPERTY enumeration describing the property type that is set. This must be one of the following:

| Property | Meaning | | HttpRequestPropertyStreamError | Sets a stream error on the request. |

[in] Input

A pointer to the buffer that contains the property information.

It must point to one of the following property information types based on the property that is set.

| Property | Configuration Type | | HttpRequestPropertyStreamError | HTTP_REQUEST_PROPERTY_STREAM_ERROR structure |

[in] InputPropertySize

The length, in bytes, of the buffer pointed to by the Input parameter.

[in] Overlapped

For asynchronous calls, set pOverlapped to point to an OVERLAPPED structure; for synchronous calls, set it to NULL.

A synchronous call blocks until the operation is complete, whereas an asynchronous call immediately returns ERROR_IO_PENDING and the calling application then uses GetOverlappedResult or I/O completion ports to determine when the operation is completed. For more information about using OVERLAPPED structures for synchronization, see Synchronization and Overlapped Input and Output.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns a system error code.

Requirements

Requirement Value
Target Platform Windows
Header http.h
Library Httpapi.lib
DLL Httpapi.dll

See also

HttpSetRequestQueueProperty