HTTP_REQUEST_V1 structure (http.h)
Uses the HTTP_REQUEST structure to return data associated with a specific request.
Do not use HTTP_REQUEST_V1 directly in your code; using HTTP_REQUEST instead ensures that the proper version, based on the operating system the code is compiled under, is used.
Syntax
typedef struct _HTTP_REQUEST_V1 {
ULONG Flags;
HTTP_CONNECTION_ID ConnectionId;
HTTP_REQUEST_ID RequestId;
HTTP_URL_CONTEXT UrlContext;
HTTP_VERSION Version;
HTTP_VERB Verb;
USHORT UnknownVerbLength;
USHORT RawUrlLength;
PCSTR pUnknownVerb;
PCSTR pRawUrl;
HTTP_COOKED_URL CookedUrl;
HTTP_TRANSPORT_ADDRESS Address;
HTTP_REQUEST_HEADERS Headers;
ULONGLONG BytesReceived;
USHORT EntityChunkCount;
PHTTP_DATA_CHUNK pEntityChunks;
HTTP_RAW_CONNECTION_ID RawConnectionId;
PHTTP_SSL_INFO pSslInfo;
} HTTP_REQUEST_V1, *PHTTP_REQUEST_V1;
Members
Flags
A combination of zero or more of the following flag values may be combined, with OR, as appropriate.
ConnectionId
An identifier for the connection on which the request was received. Use this value when calling HttpWaitForDisconnect or HttpReceiveClientCertificate.
RequestId
A value used to identify the request when calling HttpReceiveRequestEntityBody, HttpSendHttpResponse, and/or HttpSendResponseEntityBody.
UrlContext
The context that is associated with the URL in the pRawUrl parameter.
Windows Server 2003 with SP1 and Windows XP with SP2:
Version
An HTTP_VERSION structure that contains the version of HTTP specified by this request.
Verb
An HTTP verb associated with this request. This member can be one of the values from the
HTTP_VERB enumeration.
UnknownVerbLength
If the Verb member contains a value equal to HttpVerbUnknown, the UnknownVerbLength member contains the size, in bytes, of the string pointed to by the pUnknownVerb member, not including the terminating null character. If Verb is not equal to HttpVerbUnknown, UnknownVerbLength is equal to zero.
RawUrlLength
The size, in bytes, of the unprocessed URL string pointed to by the pRawUrl member, not including the terminating null character.
pUnknownVerb
If the Verb member is equal to HttpVerbUnknown, pUnknownVerb, points to a null-terminated string of octets that contains the HTTP verb for this request; otherwise, the application ignores this parameter.
pRawUrl
A pointer to a string of octets that contains the original, unprocessed URL targeted by this request. Use this unprocessed URL only for tracking or statistical purposes; the CookedUrl member contains the canonical form of the URL for general use.
CookedUrl
An HTTP_COOKED_URL structure that contains a parsed canonical wide-character version of the URL targeted by this request. This is the version of the URL HTTP Listeners should act upon, rather than the raw URL.
Address
An HTTP_TRANSPORT_ADDRESS structure that contains the transport addresses for the connection for this request.
Headers
An HTTP_REQUEST_HEADERS structure that contains the headers specified in this request.
BytesReceived
The total number of bytes received from the network comprising this request.
EntityChunkCount
The number of elements in the pEntityChunks array. If no entity body was copied, this value is zero.
pEntityChunks
A pointer to an array of HTTP_DATA_CHUNK structures that contains the data blocks making up the entity body. HttpReceiveHttpRequest does not copy the entity body unless called with the HTTP_RECEIVE_REQUEST_FLAG_COPY_BODY flag set.
RawConnectionId
Raw connection ID for an Secure Sockets Layer (SSL) request.
pSslInfo
A pointer to an HTTP_SSL_INFO structure that contains Secure Sockets Layer (SSL) information about the connection on which the request was received.
Remarks
The unprocessed URL contained in the pRawUrl member is for tracking and statistical purposes only. For other purposes, use the processed, canonical URL contained in the CookedUrl member.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Header | http.h |