Microsoft.AspNetCore.Server.HttpSys Exposes the Http.Sys authentication configurations. When attaching to an existing queue this setting must match the one used to create the queue. Indicates if anonymous requests will be surfaced to the application or challenged by the server. The default value is true. If true the server should set HttpContext.User. If false the server will only provide an identity when explicitly requested by the AuthenticationScheme. The default is true. Sets the display name shown to users on login pages. The default is null. If true, the Kerberos authentication credentials are persisted per connection and re-used for subsequent anonymous requests on the same connection. Kerberos or Negotiate authentication must be enabled. The default is false. This option maps to the native HTTP_AUTH_EX_FLAG_ENABLE_KERBEROS_CREDENTIAL_CACHING flag. If true, the server captures user credentials from the thread that starts the host and impersonates that user during Kerberos or Negotiate authentication. Kerberos or Negotiate authentication must be enabled. The default is false. This option maps to the native HTTP_AUTH_EX_FLAG_CAPTURE_CREDENTIAL flag. Specifies protocols for authentication. No authentication is enabled. This should only be used when HttpSysOptions.Authentication.AllowAnonymous is enabled (see ). Specifies basic authentication. Specifies NTLM authentication. Negotiates with the client to determine the authentication scheme. If both client and server support Kerberos, it is used; otherwise, NTLM is used. Specifies Kerberos authentication. Describes the client certificate negotiation method for HTTPS connections. A client certificate will not be populated on the request. A client certificate will be populated if already present at the start of a request. The TLS session can be renegotiated to request a client certificate. Rule that maintains a handle to the Request Queue and UrlPrefix to delegate to. The name of the Http.Sys request queue The URL of the Http.Sys Url Prefix A private utility routine to convert an integer to a chunk header, which is an ASCII hex number followed by a CRLF.The header is returned as a byte array. Generates a right-aligned hex string and returns the start offset. Chunk size to be encoded A byte array with the header in int. Enum declaring the allowed values for the verbosity level when http.sys reject requests due to throttling. A 503 response is not sent; the connection is reset. This is the default HTTP Server API behavior. The HTTP Server API sends a 503 response with a "Service Unavailable" reason phrase. The HTTP Server API sends a 503 response with a detailed reason phrase. Constants for HttpSys. The name of the authentication scheme used. Exception thrown by HttpSys when an error occurs An HTTP server wrapping the Http.Sys APIs that accepts requests. Start accepting incoming requests. Stop the server and clean up. Accept a request from the incoming request queue. Contains the options used by HttpSys. Initializes a new . The name of the Http.Sys request queue The default is `null` (Anonymous queue). This indicates whether the server is responsible for creating and configuring the request queue, or if it should attach to an existing queue. Most existing configuration options do not apply when attaching to an existing queue. The default is `RequestQueueMode.Create`. Indicates how client certificates should be populated. The default is to allow a certificate without renegotiation. This does not change the netsh 'clientcertnegotiation' binding option which will need to be enabled for ClientCertificateMethod.AllowCertificate to resolve a certificate. The maximum number of concurrent accepts. The default is 5 times the number of processors as returned by . Attempt kernel-mode caching for responses with eligible headers. The response may not include Set-Cookie, Vary, or Pragma headers. It must include a Cache-Control header that's public and either a shared-max-age or max-age value, or an Expires header. The default is `true`. The url prefixes to register with Http.Sys. These may be modified at any time prior to disposing the listener. When attached to an existing queue the prefixes are only used to compute PathBase for requests. Http.Sys authentication settings. These may be modified at any time prior to disposing the listener. Exposes the Http.Sys timeout configurations. These may also be configured in the registry. These may be modified at any time prior to disposing the listener. These settings do not apply when attaching to an existing queue. Gets or Sets if response body writes that fail due to client disconnects should throw exceptions or complete normally. The default is `false` (complete normally). Enable buffering of response data in the Kernel. The default value is false. It should be used by an application doing synchronous I/O or by an application doing asynchronous I/O with no more than one outstanding write at a time, and can significantly improve throughput over high-latency connections. Applications that use asynchronous I/O and that may have more than one send outstanding at a time should not use this flag. Enabling this can results in higher CPU and memory usage by Http.Sys. Gets or sets the maximum number of concurrent connections to accept. Set `-1` for infinite. Set to `null` to use the registry's machine-wide setting. The default value is `null` (machine-wide setting). Gets or sets the maximum number of requests that will be queued up in Http.Sys. This settings does not apply when attaching to an existing queue. The default is 1000. Gets or sets the security descriptor for the request queue. Only applies when creating a new request queue, see . Gets or sets the maximum allowed size of any request body in bytes. When set to null, the maximum request body size is unlimited. This limit has no effect on upgraded connections which are always unlimited. This can be overridden per-request via . The default is set to 30,000,000 bytes, which is approximately 28.6MB. Control whether synchronous input/output is allowed for the HttpContext.Request.Body and HttpContext.Response.Body. The default is `false`. Gets or sets a value that controls how http.sys reacts when rejecting requests due to throttling conditions - like when the request queue limit is reached. The default in http.sys is "Basic" which means http.sys is just resetting the TCP connection. IIS uses Limited as its default behavior which will result in sending back a 503 - Service Unavailable back to the client. This settings does not apply when attaching to an existing queue. Inline request processing instead of dispatching to the threadpool. Enabling this setting will run application code on the IO thread to reduce request processing latency. However, this will limit parallel request processing to . This setting can make overall throughput worse if requests take long to process. Configures request headers to use encoding. Defaults to false, in which case will be used. />. Defines the types of request processing timestamps exposed via the Http.Sys HTTP_REQUEST_TIMING_INFO extensibility point. Use to access these timestamps. Time the connection started. Time the first HTTP byte is received. Time TLS certificate loading starts. Time TLS certificate loading ends. Time TLS leg one handshake starts. Time TLS leg one handshake ends. Time TLS leg two handshake starts. Time TLS leg two handshake ends. Time TLS attribute query starts. Time TLS attribute query ends. Time TLS client cert query starts. Time TLS client cert query ends. Time HTTP2 streaming starts. Time HTTP2 header decoding starts. Time HTTP2 header decoding ends. Time HTTP header parsing starts. For most requests, this is a good timestamp to use as a per request starting timestamp. Time HTTP header parsing ends. Time Http.Sys starts to determine which request queue to route the request to. Time Http.Sys has determined which request queue to route the request to. Time the request is queued for inspection. Time the request is delivered for inspection. Time the request has finished being inspected. Time the request is queued for delegation. Time the request is delivered for delegation. Time the request was delegated. Time the request was queued to the final request queue for processing. Time the request was delivered to the final request queue for processing. Time HTTP3 streaming starts. Time HTTP3 header decoding starts. Time HTTP3 header decoding ends. Interface for delegating requests to other Http.Sys request queues. Indicates if the server can delegate this request to another HttpSys request queue. Attempt to delegate the request to another Http.Sys request queue. The request body must not be read nor the response started before this is invoked. Check before invoking. The rule maintaining the handle to the destination queue. This exposes the Http.Sys HTTP_REQUEST_INFO extensibility point as opaque data for the caller to interperate. , A collection of the HTTP_REQUEST_INFO for the current request. The integer represents the identifying HTTP_REQUEST_INFO_TYPE enum value. The Memory is opaque bytes that need to be interperted in the format specified by the enum value. Provides API to read HTTP_REQUEST_PROPERTY value from the HTTP.SYS request. Reads the TLS client hello from HTTP.SYS Where the raw bytes of the TLS Client Hello message are written. Returns the number of bytes written to . Or can return the size of the buffer needed if wasn't large enough. Works only if HTTP_SERVICE_CONFIG_SSL_FLAG_ENABLE_CACHE_CLIENT_HELLO flag is set on http.sys service configuration. See and

If you don't want to guess the required size before first invocation, you should first call with set to empty size, so that you can retrieve the required buffer size from , then allocate that amount of memory and retry the query. True, if fetching TLS client hello was successful, false if size is not large enough. If unsuccessful for other reason throws an exception. Any HttpSys error except for ERROR_INSUFFICIENT_BUFFER or ERROR_MORE_DATA. If HttpSys does not support querying the TLS Client Hello. This exposes the Http.Sys HTTP_REQUEST_TIMING_INFO extensibility point which contains request processing timestamp data from Http.Sys. Gets all Http.Sys timing timestamps These timestamps were obtained using QueryPerformanceCounter and the timestamp frequency can be obtained via QueryPerformanceFrequency . The index of the timing can be cast to to know what the timing represents. The value may be 0 if the timing is not available for the current request. Gets the timestamp for the given timing. These timestamps were obtained using QueryPerformanceCounter and the timestamp frequency can be obtained via QueryPerformanceFrequency . The timestamp type to get. The value of the timestamp if set. True if the given timing was set (i.e., non-zero). Gets the elapsed time between the two given timings. The timestamp type marking the beginning of the time period. The timestamp type marking the end of the time period. A for the elapsed time between the starting and ending timestamps. True if both given timings were set (i.e., non-zero). This exposes the creation of delegation rules on request queues owned by the server. Create a delegation rule on request queue owned by the server. The name of the Http.Sys request queue. The URL of the Http.Sys Url Prefix. Creates a that can used to delegate individual requests. True if this instace created the queue instead of attaching to an existing one. Represents a handle to a Windows module (DLL). Returns a value stating whether the library exports a given proc. Gets a delegate pointing to a given export from this library. Opens a library. If 'filename' is not a fully-qualified path, the default search path is used. Flushes and completes the response. Forcibly terminate and dispose the request, closing the connection if necessary. Gets TLS cipher suite used for the request, if supported by the OS and http.sys. null, if query of TlsCipherSuite is not supported or the query failed. TlsCipherSuite value, if query is successful. Attempts to get the client hello message bytes from the http.sys. If successful writes the bytes into , and shows how many bytes were written in . If not successful because is not large enough, returns false and shows a size of required in . If not successful for other reason - throws exception with message/errorCode. The authentication challenges that will be added to the response if the status code is 401. This must be a subset of the AuthenticationSchemes enabled on the server. Enable kernel caching for the response with the given timeout. Http.Sys determines if the response can be cached. Indicates if the response status, reason, and headers are prepared to send and can no longer be modified. This is caused by the first write or flush to the response body. Used to indicate if this server instance should create a new Http.Sys request queue or attach to an existing one. Create a new queue. This will fail if there's an existing queue with the same name. Attach to an existing queue with the name given. This will fail if the queue does not already exist. Most configuration options do not apply when attaching to an existing queue. Create a queue with the given name if it does not already exist, otherwise attach to the existing queue. Most configuration options do not apply when attaching to an existing queue. Exposes the Http.Sys timeout configurations. These may also be configured in the registry. These settings do not apply when attaching to an existing queue. The time, in seconds, allowed for the request entity body to arrive. The default timer is 2 minutes. The HTTP Server API turns on this timer when the request has an entity body. The timer expiration is initially set to the configured value. When the HTTP Server API receives additional data indications on the request, it resets the timer to give the connection another interval. Use TimeSpan.Zero to indicate that system defaults should be used. The time, in seconds, allowed for the HTTP Server API to drain the entity body on a Keep-Alive connection. The default timer is 2 minutes. On a Keep-Alive connection, after the application has sent a response for a request and before the request entity body has completely arrived, the HTTP Server API starts draining the remainder of the entity body to reach another potentially pipelined request from the client. If the time to drain the remaining entity body exceeds the allowed period the connection is timed out. Use TimeSpan.Zero to indicate that system defaults should be used. The time, in seconds, allowed for the request to remain in the request queue before the application picks it up. The default timer is 2 minutes. Use TimeSpan.Zero to indicate that system defaults should be used. The time, in seconds, allowed for an idle connection. The default timer is 2 minutes. This timeout is only enforced after the first request on the connection is routed to the application. Use TimeSpan.Zero to indicate that system defaults should be used. The time, in seconds, allowed for the HTTP Server API to parse the request header. The default timer is 2 minutes. This timeout is only enforced after the first request on the connection is routed to the application. Use TimeSpan.Zero to indicate that system defaults should be used. The minimum send rate, in bytes-per-second, for the response. The default response send rate is 150 bytes-per-second. Use 0 to indicate that system defaults should be used. To disable this timer set it to UInt32.MaxValue A set of URL parameters used to listen for incoming requests. http://msdn.microsoft.com/en-us/library/windows/desktop/aa364698(v=vs.85).aspx http or https. Will be normalized to lower case. +, *, IPv4, [IPv6], or a dns name. Http.Sys does not permit punycode (xn--), use Unicode instead. If empty, the default port for the given scheme will be used (80 or 443). Should start and end with a '/', though a missing trailing slash will be added. This value must be un-escaped. http://msdn.microsoft.com/en-us/library/windows/desktop/aa364698(v=vs.85).aspx http or https. Will be normalized to lower case. +, *, IPv4, [IPv6], or a dns name. Http.Sys does not permit punycode (xn--), use Unicode instead. If empty, the default port for the given scheme will be used (80 or 443). Should start and end with a '/', though a missing trailing slash will be added. This value must be un-escaped. http://msdn.microsoft.com/en-us/library/windows/desktop/aa364698(v=vs.85).aspx The string that the will be created from. Gets a value that determines if the prefix's scheme is HTTPS. Gets the scheme used by the prefix. Gets the host domain name used by the prefix. Gets a string representation of the port used by the prefix. Gets an integer representation of the port used by the prefix. Gets the path component of the prefix. Gets a string representation of the prefix A collection or URL prefixes Gets a value that determines if this collection is readOnly. Creates a from the given string, and adds it to this collection. The string representing the to add to this collection. Adds a to this collection. The prefix to add to this collection. Returns an enumerator that iterates through this collection. The prefix '{0}' is not registered. Please run the following command as Administrator to register this prefix: netsh http add urlacl url={0} user={1} See "Preregister URL prefixes on the server" on https://go.microsoft.com/fwlink/?linkid=2127065 for more i ... The prefix '{0}' is not registered. Please run the following command as Administrator to register this prefix: netsh http add urlacl url={0} user={1} See "Preregister URL prefixes on the server" on https://go.microsoft.com/fwlink/?linkid=2127065 for more i ... The destination array is too small. End has already been called. The status code '{0}' is not supported. The status code '{0}' is not supported. The stream is not seekable. The prefix '{0}' is already registered. The prefix '{0}' is already registered. This stream only supports read operations. More data written than specified in the Content-Length header. Only the http and https schemes are supported. This stream only supports write operations. The given IAsyncResult does not match this opperation. An exception occurred while running an action registered with {0}. An exception occurred while running an action registered with {0}. A faster version of String.Concat(, , .ToString("X8")) Provides extensions method to use Http.sys as the server for the web host. Specify Http.sys as the server to be used by the web host. The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure. A reference to the parameter object. Specify Http.sys as the server to be used by the web host. The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure. A callback to configure Http.sys options. A reference to the parameter object. Shows whether was already invoked on this native request context Find the segment of the URI byte array which represents the path. Compare the beginning portion of the raw URL byte array to https:// and http:// The byte array represents the raw URI Length of the matched bytes, 0 if it is not matched. Unescape a given path string in place. The given path string may contain escaped char. The raw path string to be unescaped The unescaped path string Unescape the percent-encodings The iterator point to the first % char The place to write to The end of the buffer The byte array Read the percent-encoding and try unescape it. The operation first peek at the character the iterator points at. If it is % the is then moved on to scan the following to characters. If the two following characters are hexadecimal literals they will be unescaped and the value will be returned. If the first character is not % the iterator will be removed beyond the location of % and -1 will be returned. If the following two characters can't be successfully unescaped the iterator will be move behind the % and -1 will be returned. The value to read The end of the buffer The byte array The unescaped byte if success. Otherwise return -1. Read the next char and convert it into hexadecimal value. The iterator will be moved to the next byte no matter no matter whether the operation successes. The value to read The end of the buffer The byte array The hexadecimal value if successes, otherwise -1. Used to allocate and distribute re-usable blocks of memory. This default value passed in to Rent to use the default value for the pool. Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The individual blocks are then treated as independent array segments. Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool. This object cannot be instantiated outside of the static Create method Wraps an array allocated in the pinned object heap in a reusable block of managed memory Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool. Used to allocate and distribute re-usable blocks of memory. The size of a block. 4096 is chosen because most operating systems use 4k pages. The size of a block. 4096 is chosen because most operating systems use 4k pages. Max allocation block size for pooled blocks, larger values can be leased but they will be disposed after use rather than returned to the pool. Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added. This is part of implementing the IDisposable pattern. This default value passed in to Rent to use the default value for the pool. Register a callback to call when the pool is being disposed. Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid leaving "dead zones" in the slab due to lost block tracking objects. The block to return. It must have been acquired by calling Lease on the same memory pool instance. Examines the current usage and activity of the memory pool and evicts a calculated number of unused memory blocks. The eviction policy is adaptive: if the pool is underutilized or idle, more blocks are evicted; if activity is high, fewer or no blocks are evicted. Evicted blocks are removed from the pool and their memory is unrooted for garbage collection. Defines a key/value pair for displaying an item of a dictionary by a debugger. Allocator that manages blocks of unmanaged memory. The default block size for the allocator. This size assumes a common page size and provides an accommodation for the pointer chain used to track allocated blocks. Instantiate an instance. The unmanaged memory block size in bytes. Allocate the requested amount of space from the allocator. The type requested The count in units A pointer to the reserved memory. The allocated memory is uninitialized. Allocate the requested amount of space from the allocator. The type requested The count in units A Span to the reserved memory. The allocated memory is uninitialized. Get pointer to bytes for the supplied string in UTF-8. The string The length of the returned byte buffer. A pointer to the buffer of bytes Provides support for efficiently using Tasks to implement the APM (Begin/End) pattern. Marshals the Task as an IAsyncResult, using the supplied callback and state to implement the APM pattern. The Task to be marshaled. The callback to be invoked upon completion. The state to be stored in the IAsyncResult. An IAsyncResult to represent the task's asynchronous operation. Processes an IAsyncResult returned by Begin. The IAsyncResult to unwrap. Processes an IAsyncResult returned by Begin. The IAsyncResult to unwrap. Provides a simple IAsyncResult that wraps a Task. We could use the Task as the IAsyncResult if the Task's AsyncState is the same as the object state, but that's very rare, in particular in a situation where someone cares about allocation, and always using TaskAsyncResult simplifies things and enables additional optimizations. The wrapped Task. Callback to invoke when the wrapped task completes. Initializes the IAsyncResult with the Task to wrap and the associated object state. The Task to wrap. The new AsyncState value. Callback to invoke when the wrapped task completes. Invokes the callback. Gets a user-defined object that qualifies or contains information about an asynchronous operation. Gets a value that indicates whether the asynchronous operation completed synchronously. This is set lazily based on whether the has completed by the time this object is created. Gets a value that indicates whether the asynchronous operation has completed. Gets a that is used to wait for an asynchronous operation to complete. Header of an access control list (ACL). An ACL includes a sequential list of zero or more ACEs. The individual ACEs in an ACL are numbered from 0 to n, where n+1 is the number of ACEs in the ACL. When editing an ACL, an application refers to an ACE within the ACL by the ACE's index. There are two types of ACL: discretionary and system. A discretionary access control list (DACL) is controlled by the owner of an object or anyone granted WRITE_DAC access to the object. It specifies the access particular users and groups can have to an object. For example, the owner of a file can use a DACL to control which users and groups can and cannot have access to the file. An object can also have system-level security information associated with it, in the form of a system access control list (SACL) controlled by a system administrator. A SACL allows the system administrator to audit any attempts to gain access to an object. For a list of currently defined ACE structures, see ACE. A fourth ACE structure, SYSTEM_ALARM_ACE, is not currently supported. The ACL structure is to be treated as though it were opaque and applications are not to attempt to work with its members directly. To ensure that ACLs are semantically correct, applications can use the functions listed in the See Also section to create and manipulate ACLs. Each ACL and ACE structure begins on a DWORD boundary. The maximum size for an ACL, including its ACEs, is 64 KB. Read more on docs.microsoft.com. Specifies the revision level of the ACL. This value should be ACL_REVISION, unless the ACL contains an object-specific ACE, in which case this value must be ACL_REVISION_DS. All ACEs in an ACL must be at the same revision level. Specifies a zero byte of padding that aligns the AclRevision member on a 16-bit boundary. Specifies the size, in bytes, of the ACL. This value includes both the ACL structure and all the ACEs. Specifies the number of ACEs stored in the ACL. Specifies two zero-bytes of padding that align the ACL structure on a 32-bit boundary. The SECURITY_ATTRIBUTES structure contains the security descriptor for an object and specifies whether the handle retrieved by specifying this structure is inheritable. The size, in bytes, of this structure. Set this value to the size of the **SECURITY\_ATTRIBUTES** structure. A pointer to a [**SECURITY\_DESCRIPTOR**](../winnt/ns-winnt-security_descriptor.md) structure that controls access to the object. If the value of this member is **NULL**, the object is assigned the default security descriptor associated with the [*access token*](/windows/win32/secauthz/access-tokens) of the calling process. This is not the same as granting access to everyone by assigning a **NULL** [*discretionary access control list*](/windows/win32/secauthz/dacls-and-aces) (DACL). By default, the default DACL in the access token of a process allows access only to the user represented by the access token. For information about creating a security descriptor, see [Creating a Security Descriptor](/windows/win32/secauthz/creating-a-security-descriptor-for-a-new-object-in-c--). Read more on docs.microsoft.com. A Boolean value that specifies whether the returned handle is inherited when a new process is created. If this member is **TRUE**, the new process inherits the handle. Contains values that correspond to the types of Windows objects that support security. Learn more about this API from docs.microsoft.com. Unknown object type. Indicates a file or directory. The name string that identifies a file or directory object can be in one of the following formats: This doc was truncated. Read more on docs.microsoft.com. Indicates a Windows service. A service object can be a local service, such as ServiceName, or a remote service, such as \\ComputerName\ServiceName. Indicates a printer. A printer object can be a local printer, such as PrinterName, or a remote printer, such as \\ComputerName\PrinterName. Indicates a registry key. A registry key object can be in the local registry, such as CLASSES_ROOT\SomePath or in a remote registry, such as \\ComputerName\CLASSES_ROOT\SomePath. The names of registry keys must use the following literal strings to identify the predefined registry keys: "CLASSES_ROOT", "CURRENT_USER", "MACHINE", and "USERS". Read more on docs.microsoft.com. Indicates a network share. A share object can be local, such as ShareName, or remote, such as \\ComputerName\ShareName. Indicates a local kernel object. The GetSecurityInfo and SetSecurityInfo functions support all types of kernel objects. The GetNamedSecurityInfo and SetNamedSecurityInfo functions work only with the following kernel objects: semaphore, event, mutex, waitable timer, and file mapping. Read more on docs.microsoft.com. Indicates a window station or desktop object on the local computer. You cannot use GetNamedSecurityInfo and SetNamedSecurityInfo with these objects because the names of window stations or desktops are not unique. Read more on docs.microsoft.com. Indicates a directory service object or a property set or property of a directory service object. The name string for a directory service object must be in X.500 form, for example: CN=SomeObject,OU=ou2,OU=ou1,DC=DomainName,DC=CompanyName,DC=com,O=internet Read more on docs.microsoft.com. Indicates a directory service object and all of its property sets and properties. Indicates a provider-defined object. Indicates a WMI object. Indicates an object for a registry entry under WOW64. The IN6_ADDR structure specifies an IPv6 transport address. All members of the IN6_ADDR structure must be specified in network-byte-order (big-endian). A union that contains the following different representations of the IPv6 transport address: Read more on docs.microsoft.com. The in_addr structure represents an IPv4 address. The IPaddr type definition also represents an IPv4 address and can be cast to an in_addr structure when needed. On the Microsoft Windows Software Development Kit (SDK) released for Windows Vista and later, the organization of header files has changed and the in_addr structure is defined in the Inaddr.h header file which is automatically included by the Ipexport.h header file. On the Platform Software Development Kit (SDK) released for Windows Server 2003 and Windows XP, the in_addr structure is declared in the Ipexport.h header file. Read more on docs.microsoft.com. The sockaddr structure varies depending on the protocol selected. (sockaddr) Learn more about this API from docs.microsoft.com. The SOCKADDR_IN (winsock.h) structure varies depending on the protocol selected. Learn more about this API from docs.microsoft.com. Defines the version of the HTTP Server API. Constants that represents the version of the API are pre-defined in the Http.h header file as follows: "#define HTTPAPI_VERSION_1 {1, 0}" "#define HTTPAPI_VERSION_2 {2, 0}" Read more on docs.microsoft.com. Major version of the HTTP Server API. Minor version of the HTTP Server API. Server Hardening level. Learn more about this API from docs.microsoft.com. Server is not hardened and operates without Channel Binding Token (CBT) support. Server is partially hardened. Clients that support CBT are serviced appropriately. Legacy clients are also serviced. Server is hardened. Only clients that supported CBT are serviced. Defines the authentication state of a request. Learn more about this API from docs.microsoft.com. The request was successfully authenticated for the authentication type indicated in the HTTP_REQUEST_AUTH_INFO structure. Authentication was configured on the URL group for this request, however, the HTTP Server API did not handle the authentication. This could be because of one of the following reasons: This doc was truncated. Read more on docs.microsoft.com. This doc was truncated. Read more on docs.microsoft.com. Used to associate a URL Group with a request queue. Learn more about this API from docs.microsoft.com. The HTTP_PROPERTY_FLAGS structure specifying whether the property is present. The request queue that is associated with the URL group. The structure can be used to remove an existing binding by setting this parameter to NULL. The HTTP_BYTE_RANGE structure is used to specify a byte range within a cached response fragment, file, or other data block. Learn more about this API from docs.microsoft.com. Starting offset of the byte range. Size, in bytes, of the range. If this member is HTTP_BYTE_RANGE_TO_EOF, the range extends from the starting offset to the end of the file or data block. Used to define a cache policy associated with a cached response fragment. Learn more about this API from docs.microsoft.com. When the Policy member is equal to HttpCachePolicyTimeToLive, data is cached for SecondsToLive seconds before it is released. For other values of Policy, SecondsToLive is ignored. The HTTP_CACHE_POLICY_TYPE enumeration type defines available cache policies. Learn more about this API from docs.microsoft.com. Do not cache this value at all. Cache this value until the user provides a different one. Cache this value for a specified time and then remove it from the cache. Terminates the enumeration; not used to determine policy. An HTTP_AUTHENTICATION_HARDENING_LEVELS value indicating the hardening level levels to be set or queried per server session or URL group. A bitwise OR combination of flags that determine the behavior of authentication. The following values are supported. This doc was truncated. Read more on docs.microsoft.com. Pointer to a buffer holding an array of 1 or more service names. Each service name is represented by either an HTTP_SERVICE_BINDING_A structure or an HTTP_SERVICE_BINDING_W structure, dependent upon whether the name is ASCII or Unicode. Regardless of which structure type is used, the array is cast into a pointer to an HTTP_SERVICE_BINDING_BASE structure. The number of names in ServiceNames. Used to set or query the limit on the maximum number of outstanding connections for a URL Group. Learn more about this API from docs.microsoft.com. The HTTP_PROPERTY_FLAGS structure specifying whether the property is present. The number of connections allowed. Setting this value to HTTP_LIMIT_INFINITE allows an unlimited number of connections. Contains a validated, canonical, UTF-16 Unicode-encoded URL request string together with pointers into it and element lengths. For example, if pFullUrl is "http://www.fabrikam.com/path1/path2/file.ext?n1=v1&n2=v2", then pHost points to "www.fabrikam", pAbsPath points to "/path1/…" and pQueryString points to "?n1=v1…". Size, in bytes, of the data pointed to by the pFullUrl member, not including a terminating null character. Size, in bytes, of the data pointed to by the pHost member. Size, in bytes, of the data pointed to by the pAbsPath member. Size, in bytes, of the data pointed to by the pQueryString member. Pointer to the scheme element at the beginning of the URL (must be either "http://..." or "https://..."). Pointer to the first character in the host element, immediately following the double slashes at the end of the scheme element. Pointer to the third forward slash ("/") in the string. In a UrlPrefix string, this is the slash immediately preceding the relativeUri element. Pointer to the first question mark (?) in the string, or NULL if there is none. Represents an individual block of data either in memory, in a file, or in the HTTP Server API response-fragment cache. Learn more about this API from docs.microsoft.com. Type of data store. This member can be one of the values from the HTTP_DATA_CHUNK_TYPE enumeration. Defines the data source for a data chunk. Learn more about this API from docs.microsoft.com. The data source is a memory data block. The union should be interpreted as a FromMemory structure. The data source is a file handle data block. The union should be interpreted as a FromFileHandle structure. The data source is a fragment cache data block. The union should be interpreted as a FromFragmentCache structure. The data source is a fragment cache data block. The union should be interpreted as a FromFragmentCacheEx structure. Windows Server 2003 with SP1 and Windows XP with SP2:  This flag is not supported. Read more on docs.microsoft.com. The data source is a trailers data block. The union should be interpreted as a Trailers structure. Windows 10, version 2004 and prior:  This flag is not supported. Read more on docs.microsoft.com. Describes property information for a delegate request. This property is reserved. Specifies the property that provides the target url to which a delegated request should be delivered. Describes additional property information when delegating a request. Type: **[HTTP_DELEGATE_REQUEST_PROPERTY_ID](./ne-http-http_delegate_request_property_id.md)** The type of property info pointed to by this struct. Read more on docs.microsoft.com. Type: **[ULONG](/windows/win32/winprog/windows-data-types)** The length in bytes of the value of the *PropertyInfo* parameter. Read more on docs.microsoft.com. Type: **[PVOID](/windows/win32/winprog/windows-data-types)** A pointer to the property information. Read more on docs.microsoft.com. Defines constants that specify an identifier for an HTTP feature. Specifies an unknown feature. Specifies HTTP response trailers. Specifies HTTP API timings. Specifies a request for delegation. Specifies the maximum number of supported features. The HTTP_HEADER_ID enumeration type lists known headers for HTTP requests and responses, and associates an array index with each such header. Learn more about this API from docs.microsoft.com. Used to specify caching behavior along the request or response chain, overriding the default caching algorithm. Allows the sender to specify options that are desired for that particular connection. These are used for a single connection only and must not be communicated by proxies over further connections. The Date is a general header field that indicates the time that the request or response was sent. Based on the keepalive XML element (see RFC 2518, section 12.12.1, page 66); a list of URIs included in the KeepAlive header must be "live" after they are copied (moved) to the destination. Read more on docs.microsoft.com. Used to include optional, implementation-specific directives that might apply to any recipient along the request/response chain. Indicates that specified header fields are present in the trailer of a message encoded with chunked transfer-coding. Indicates what, if any, transformations have been applied to the message body in transit. Allows the client to specify one or more other communication protocols it would prefer to use if the server can comply. The Via header field indicates the path taken by the request. This is a response header that contains the 3-digit warn code along with the reason phrase. Lists the set of methods supported by the resource identified by the Request-URI. The size of the message body in decimal bytes. The media type of the message body. The encoding scheme for the message body. Provides the natural language of the intended audience. Location of the resource for the entity enclosed in the message when that entity is accessible from a location separate from the requested resource's URI. An MD5 digest of the entity-body used to provide end-to-end message integrity check (MIC) of the entity-body. The content range header is sent with a partial entity body to specify where in the full entity body the partial body should be applied. The date and time after which the message content expires. Indicates the date and time at which the origin server believes the variant was last modified. Used with the INVITE, OPTIONS, and REGISTER methods to indicate what media types are acceptable in the response. Indicates the character sets that are acceptable for the response. The content encodings that are acceptable in the response. Used by the client to indicate to the server which language it would prefer to receive reason phrases, session descriptions, or status responses. The user-agent can authenticate itself with a server by sending the Authorization request header field with the request. The field contains the credentials for the domain that the user is requesting. The cookie request header contains data used to maintain client state with the server. Cookie data is obtained from a response sent with HttpHeaderSetCookie. Indicates the specific server behaviors that are required by the client. The From header field specifies the initiator of the SIP request or response message. Specifies the Internet host and port number of the requested resource. This is obtained from the original URI given by the user or referring resource. The If-Match request header field is used with a method to make it conditional. A client that has one or more entities previously obtained from the resource can verify that one of those entities is current by including a list of their associated entity tags in the If-Match header field. The If-Modified-Since request header field is used with a method to make it conditional. If the requested variant has not been modified since the time specified in this field, an entity is not returned from the server; instead, a 304 (not modified) response is returned without any message-body. The If-None-Match request-header field is used with a method to make it conditional. When a client has obtained one or more entities from a resource, it can verify that none of those entities is current by including a list of their associated entity tags in the If-None-Match header field. The purpose of this feature is to allow efficient updates of cached information with a minimum amount of transaction overhead, and to prevent a method such as PUT from inadvertently modifying an existing resource when the client believes that the resource does not exist. Read more on docs.microsoft.com. If a client has a partial copy of an entity in its cache, and wishes to obtain an up-to-date copy of the entire entity, it can use the If-Range header. Informally, its meaning is, "if the entity is unchanged, send me the part(s) I am missing; otherwise, send me the entire new entity." Read more on docs.microsoft.com. The If-Unmodified-Since request-header field is used with a method to make it conditional. If the requested resource has not been modified since the time specified in this field, the server performs the requested operation as if the If-Unmodified-Since header were not present, but if the requested resource has been modified, the server returns a 412 error (Precondition Failed). Read more on docs.microsoft.com. The maximum number of proxies or gateways that can forward the request. This header field is used by the client to identify itself with a proxy. Allows the client to specify, for the server's benefit, the address (URI) of the resource from which the Request-URI was obtained. Allows a client to request a part of an entity instead of the whole. This header field contains the recipient of the SIP request or response message. Allows the client to specify whether it wants the source representation or programmatic interpretation of the requested content. Indicates what extension transfer-codings the client accepts in the response and whether or not the client accepts trailer fields in a chunked transfer-coding. Not a value that actually designates a header; instead, it is used to count the enumerated Request headers. Allows the server to indicate its acceptance of range requests for a resource. Conveys the sender's estimate of the amount of time since the response (or its revalidation) was generated at the origin server. Provides the current value of the entity tag for the requested variant. Used to redirect the recipient to a location other than the Request-URI for completion of the request or identification of a new resource. The response field that must be included as a part of the 407 response. The field includes the authentication scheme and parameters that apply to the proxy for this Request-URI. The length of time that the service is expected to be unavailable to the requesting client. This is a response header field that contains information about the server that is handling the request. The set-cookie response header contains data used to maintain client state in future requests sent with HttpHeaderCookie. Indicates the set of request header fields that fully determines, while the response is fresh, whether a cache is permitted to use the response to reply to a subsequent request without revalidation. The WWW_Authenticate header field contains the authentication schemes and parameters applicable to the Request-URI. Not a value that actually designates a header; instead, it is used to count the enumerated Response headers. Not a value that actually designates a header; instead, it is used to count all the enumerated headers. Contains the header values for a known header from an HTTP request or HTTP response. In the HTTP Server API, known headers are defined as those that are enumerated in the HTTP_HEADER_ID enumeration type. Be aware that there are different lists of different sizes for request and response headers. For more information about the structure and usage of HTTP headers, see the RFC 2616. Read more on docs.microsoft.com. Size, in bytes, of the 8-bit string pointed to by the pRawValue member, not counting a terminating null character, if present. If RawValueLength is zero, then the value of the pRawValue element is meaningless. Pointer to the text of this HTTP header. Use RawValueLength to determine where this text ends rather than relying on the string to have a terminating null. The format of the header text is specified in RFC 2616. Read more on docs.microsoft.com. The length of the inline array. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. The length of the inline array. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Contains a value that specifies the type of the log data. Learn more about this API from docs.microsoft.com. An HTTP_LOG_DATA_TYPE enumeration value that specifies the type. Identifies the type of log data. Learn more about this API from docs.microsoft.com. The HTTP_LOG_FIELDS_DATA structure is used for logging a request. This structure is passed to an HttpSendHttpResponse or HttpSendResponseEntityBody call. Specifies the headers that are included in an HTTP response when more than one header is required. The HTTP version 1.0 API allows applications to send only one known response header with the response. Starting with the HTTP version 2.0 API, applications are enabled to send multiple known response headers. The pInfo member of the HTTP_RESPONSE_INFO structure points to this structure when the application provides multiple known headers on a response. The HTTP_RESPONSE_INFO structure extends the HTTP_RESPONSE structure starting with HTTP version 2.0. The HTTP_MULTIPLE_KNOWN_HEADERS structure enables server applications to send multiple authentication challenges to the client. Read more on docs.microsoft.com. A member of the HTTP_HEADER_ID enumeration specifying the response header ID. The flags corresponding to the response header in the HeaderId member. This member is used only when the WWW-Authenticate header is present. This can be zero or the following: This doc was truncated. Read more on docs.microsoft.com. The number of elements in the array specified in the KnownHeaders member. A pointer to the first element in the array of HTTP_KNOWN_HEADER structures. Used by the property configuration structures to enable or disable a property on a configuration object when setting property configurations. The property configuration structures are used in calls to HttpSetRequestQueueProperty, HttpSetServerSessionProperty, and HttpSetUrlGroupProperty to set properties on the corresponding configuration objects. The configuration structures are also used in calls to HttpQueryRequestQueueProperty, HttpQueryServerSessionProperty, and HttpQueryUrlGroupProperty, to query properties on the corresponding configuration object. When properties are set on the URL Group, server session, or request queue, this structure enables or disables the property. When properties are queried for the URL Group, server session, or request queue, this structure is used by the application to determine if the property is present. For more information, see the list of property configuration structures in the See Also section below. Contains information about a QOS setting. Learn more about this API from docs.microsoft.com. An HTTP_QOS_SETTING_TYPE enumeration value that specifies the type of the QOS setting. A pointer to a structure that contains the setting. Identifies the type of a QOS setting contained in a HTTP_QOS_SETTING_INFO structure. Learn more about this API from docs.microsoft.com. The setting is a bandwidth limit represented by a HTTP_BANDWIDTH_LIMIT_INFO structure. The setting is a connection limit represented by a HTTP_CONNECTION_LIMIT_INFO structure. A flow rate represented by HTTP_FLOWRATE_INFO.
Note  Windows Server 2008 R2 and Windows 7 only.
 
 Read more on docs.microsoft.com. Contains the authentication status of the request with a handle to the client token that the receiving process can use to impersonate the authenticated client. Starting with HTTP version 2.0, the HTTP_REQUEST structure contains an HTTP_REQUEST_INFO structure. The pVoid member of the HTTP_REQUEST_INFO structure points to the HTTP_REQUEST_AUTH_INFO when the request information type is HttpRequestInfoTypeAuth. When the application receives a request with this structure and the request has not been authenticated, it can send the initial 401 challenge with the desired set of WWW-Authenticate headers in the HTTP_MULTIPLE_KNOWN_HEADERS structure. When the HTTP Server API completes the authentication handshake, it fills the HTTP_REQUEST_AUTH_INFO structure and passes it to the application with the request again. The handle to the access token that represents the client identity is provided in this structure by the HTTP Server API. Context Attributes The ContextAttributes member is provided for SSPI based schemes. For example, SSPI applications can determine whether ASC_RET_MUTUAL_AUTH is set for a mutually authenticated session. The HTTP Server API does not provide the expiration time for the context in the PackedContext member. Applications may require the expiration time in specific circumstances, for example, when NTLM credential caching is enabled and the application queries for the expiration time for a cached context. If the server application requires the expiration time for the underlying client context associated with the access token, it can receive the packed context and call QueryContextAttributes with the SECPKG_ATTR_LIFESPAN. Mutual Authentication Data By default, the HTTP Server API ensures that the mutual authentication data is added to the final 200 response; in general, server applications are not responsible for sending the mutual authentication data. However, applications can receive the mutual authentication data and send it with the final response. When the ReceiveMutualAuth member of the HTTP_SERVER_AUTHENTICATION_INFO structure is set to true, applications receive the server credentials for mutual authentication along with the authenticated request. The mutual authentication data provided in the pMutualAuthData member contains the exact value of WWW-Authenticate header without the header name. For example, pMutualAuthData points to "Negotiate ade02938481eca". The application builds the WWW-Authenticate header by appending the provided pMutualAuthData as a response header value. Read more on docs.microsoft.com. A member of the HTTP_AUTH_STATUS enumeration that indicates the final authentication status of the request. If the authentication status is not HttpAuthStatusSuccess, applications should disregard members of this structure except AuthStatus, SecStatus, and AuthType. Read more on docs.microsoft.com. A SECURITY_STATUS value that indicates the security failure status when the AuthStatus member is HttpAuthStatusFailure. The authentication flags that indicate the following authentication attributes: This doc was truncated. Read more on docs.microsoft.com. A member of the HTTP_REQUEST_AUTH_TYPE enumeration that indicates the authentication scheme attempted or established for the request. A handle to the client token that the receiving process can use to impersonate the authenticated client. The handle to the token should be closed by calling CloseHandle when it is no longer required. This token is valid only for the lifetime of the request. Applications can regenerate the initial 401 challenge to reauthenticate when the token expires. Read more on docs.microsoft.com. The client context attributes for the access token. The length, in bytes, of the PackedContext. The type of context in the PackedContext member. The security context for the authentication type. Applications can query the attributes of the packed context by calling the SSPI QueryContextAttributes API. However, applications must acquire a credential handle for the security package for the indicated AuthType. Application should call the SSPI FreeContextBuffer API to free the serialized context when it is no longer required. Read more on docs.microsoft.com. The length, in bytes, of the pMutualAuthData member. The Base64 encoded mutual authentication data used in the WWW-Authenticate header. The HTTP_REQUEST_AUTH_TYPE enumeration defines the authentication types supported by the HTTP Server API.This enumeration is used in the HTTP_REQUEST_AUTH_INFO structure. Learn more about this API from docs.microsoft.com. No authentication is attempted for the request. Basic authentication is attempted for the request. Digest authentication is attempted for the request. NTLM authentication is attempted for the request. Negotiate authentication is attempted for the request. Kerberos authentication is attempted for the request. Contains headers sent with an HTTP request. Learn more about this API from docs.microsoft.com. A number of unknown headers sent with the HTTP request. This number is the size of the array pointed to by the pUnknownHeaders member. A pointer to an array of HTTP_UNKNOWN_HEADER structures. This array contains one structure for each of the unknown headers sent in the HTTP request. Read more on docs.microsoft.com. This member is reserved and must be zero. This member is reserved and must be NULL. Fixed-size array of HTTP_KNOWN_HEADER structures. The HTTP_HEADER_ID enumeration provides a mapping from header types to array indexes. If a known header of a given type is included in the HTTP request, the array element at the index that corresponds to that type specifies the header value. Those elements of the array for which no corresponding headers are present contain a zero-valued RawValueLength member. Use RawValueLength to determine the end of the header string pointed to by pRawValue, rather than relying on the string to have a terminating null. Read more on docs.microsoft.com. Extends the HTTP_REQUEST structure with additional information about the request. Starting with the HTTP Server API version 2.0, the HTTP_REQUEST structure is extended to include an array of HTTP_REQUEST_INFO structures in the pRequestInfo member. These structures contain additional information for the request. A member of the HTTP_REQUEST_INFO_TYPE enumeration specifying the type of information contained in this structure. The length, in bytes, of the pInfo member. A pointer to the HTTP_REQUEST_AUTH_INFO structure when the InfoType member is HttpRequestInfoTypeAuth; otherwise NULL. The HTTP_REQUEST_INFO_TYPE enumeration defines the type of information contained in the HTTP_REQUEST_INFO structure. This enumeration is used in the HTTP_REQUEST_INFO structure. Learn more about this API from docs.microsoft.com. The request information type is authentication. The pInfo member of the HTTP_REQUEST_INFO structure points to a HTTP_REQUEST_AUTH_INFO structure. Read more on docs.microsoft.com. Defines the properties that are configured by the HTTP Server API on a request. The **HTTP\_REQUEST\_PROPERTY** enumeration types are used to set or query the configurations on a request. A member of this enumeration together with the associated configuration structure is used by [HttpSetRequestProperty](/windows/desktop/api/http/nf-http-httpsetrequestproperty) to define the configuration parameters. The HTTP/2 or HTTP/3 stream error on the request. The [HTTP\_REQUEST\_PROPERTY\_STREAM\_ERROR](/windows/win32/api/http/ns-http-http_request_property_stream_error) structure contains the configuration data for this property. Read more on docs.microsoft.com. The HTTP_REQUEST_PROPERTY_STREAM_ERROR structure represents an HTTP/2 or HTTP/3 stream error code. Learn more about this API from docs.microsoft.com. The protocol stream error code. Uses the HTTP_REQUEST structure to return data associated with a specific request. 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. A combination of zero or more of the following flag values may be combined, with OR, as appropriate. This doc was truncated. Read more on docs.microsoft.com. An identifier for the connection on which the request was received. Use this value when calling HttpWaitForDisconnect or HttpReceiveClientCertificate. Read more on docs.microsoft.com. A value used to identify the request when calling HttpReceiveRequestEntityBody, HttpSendHttpResponse, and/or HttpSendResponseEntityBody. Read more on docs.microsoft.com. The context that is associated with the URL in the pRawUrl parameter. Windows Server 2003 with SP1 and Windows XP with SP2:   Read more on docs.microsoft.com. An HTTP_VERSION structure that contains the version of HTTP specified by this request. Read more on docs.microsoft.com. An HTTP verb associated with this request. This member can be one of the values from the HTTP_VERB enumeration. Read more on docs.microsoft.com. 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. The size, in bytes, of the unprocessed URL string pointed to by the pRawUrl member, not including the terminating null character. 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. 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. 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. Read more on docs.microsoft.com. An HTTP_TRANSPORT_ADDRESS structure that contains the transport addresses for the connection for this request. Read more on docs.microsoft.com. An HTTP_REQUEST_HEADERS structure that contains the headers specified in this request. Read more on docs.microsoft.com. The total number of bytes received from the network comprising this request. The number of elements in the pEntityChunks array. If no entity body was copied, this value is zero. 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. Read more on docs.microsoft.com. Raw connection ID for an Secure Sockets Layer (SSL) request. A pointer to an HTTP_SSL_INFO structure that contains Secure Sockets Layer (SSL) information about the connection on which the request was received. Read more on docs.microsoft.com. Extends the HTTP_REQUEST_V1 request structure with more information about the request. Learn more about this API from docs.microsoft.com. The number of HTTP_REQUEST_INFO structures in the array pointed to by pRequestInfo. A pointer to an array of HTTP_REQUEST_INFO structures that contains additional information about the request. Contains the headers sent with an HTTP response. Learn more about this API from docs.microsoft.com. A number of unknown headers sent with the HTTP response and contained in the array pointed to by the pUnknownHeaders member. This number cannot exceed 9999. A pointer to an array of HTTP_UNKNOWN_HEADER structures that contains one structure for each of the unknown headers sent in the HTTP response. Read more on docs.microsoft.com. This member is reserved and must be zero. This member is reserved and must be NULL. Fixed-size array of HTTP_KNOWN_HEADER structures. The HTTP_HEADER_ID enumeration provides a mapping from header types to array indexes. If a known header of a given type is included in the HTTP response, the array element at the index that corresponds to that type specifies the header value. Those elements of the array for which no corresponding headers are present contain a zero-valued RawValueLength member. Use RawValueLength to determine the end of the header string pointed to by pRawValue, rather than relying on the string to have a terminating null. Read more on docs.microsoft.com. Extends the HTTP_RESPONSE structure with additional information for the response. Starting with the HTTP Server API version 2.0, the HTTP_RESPONSE structure is extended to include an array of HTTP_RESPONSE_INFO structures in the pRequestInfo member. These structures contain additional information for the response. A member of the HTTP_RESPONSE_INFO_TYPE enumeration specifying the type of information contained in this structure. The length, in bytes, of the pInfo member. A pointer to the HTTP_MULTIPLE_KNOWN_HEADERS structure when the InfoType member is HttpResponseInfoTypeMultipleKnownHeaders; otherwise NULL. The HTTP_RESPONSE_INFO_TYPE enumeration defines the type of information contained in the HTTP_RESPONSE_INFO structure.This enumeration is used in the HTTP_RESPONSE_INFO structure. Learn more about this API from docs.microsoft.com. The response information type is authentication. The pInfo member of the HTTP_RESPONSE_INFO structure points to a HTTP_MULTIPLE_KNOWN_HEADERS structure. Read more on docs.microsoft.com. Reserved for future use. Pointer to an HTTP_QOS_SETTING_INFO structure that contains information about a QOS setting. Pointer to an HTTP_CHANNEL_BIND_INFO structure that contains information on the channel binding token. Contains data associated with an HTTP response. Learn more about this API from docs.microsoft.com. The optional logging flags change the default response behavior. These can be one of any of the HTTP_RESPONSE_FLAG values. This member is ignored; the response is always an HTTP/1.1 response. Numeric status code that characterizes the result of the HTTP request (for example, 200 signifying "OK" or 404 signifying "Not Found"). For more information and a list of these codes, see Section 10 of RFC 2616. If a request is directed to a URL that is reserved but not registered, indicating that the appropriate application to handle it is not running, then the HTTP Server API itself returns a response with status code 400, signifying "Bad Request". This is transparent to the application. A code 400 is preferred here to 503 ("Server not available") because the latter is interpreted by some smart load balancers as an indication that the server is overloaded. Read more on docs.microsoft.com. Size, in bytes, of the string pointed to by the pReason member not including the terminating null. May be zero. A pointer to a human-readable, null-terminated string of printable characters that characterizes the result of the HTTP request (for example, "OK" or "Not Found"). An HTTP_RESPONSE_HEADERS structure that contains the headers used in this response. Read more on docs.microsoft.com. A number of entity-body data blocks specified in the pEntityChunks array. This number cannot exceed 100. If the response has no entity body, this member must be zero. An array of HTTP_DATA_CHUNK structures that together specify all the data blocks that make up the entity body of the response. Read more on docs.microsoft.com. Extends the HTTP version 1.0 response structure with more information for the response. Learn more about this API from docs.microsoft.com. The number of HTTP_RESPONSE_INFO structures in the array pointed to by pResponseInfo. The count of the HTTP_RESPONSE_INFO elements in the array pointed to by pResponseInfo. Read more on docs.microsoft.com. A pointer to an array of HTTP_RESPONSE_INFO structures containing more information about the request. The HTTP_SERVER_AUTHENTICATION_BASIC_PARAMS structure contains the information for Basic authentication on a URL Group.This structure is contained in the HTTP_SERVER_AUTHENTICATION_INFO structure. Learn more about this API from docs.microsoft.com. The length, in bytes, of the Realm member. The realm used for Basic authentication. The realm allows the server to be partitioned into a set of protection spaces, each with its own set of authentication schemes from the authentication database. Read more on docs.microsoft.com. Contains the information for digest authentication on a URL Group. Learn more about this API from docs.microsoft.com. The length, in bytes, of the DomainName member. The domain name used for Digest authentication. If NULL, the client assumes the protection space consists of all the URIs under the responding server. Read more on docs.microsoft.com. The length, in bytes, of the Realm member. The realm used for Digest authentication. The realm allows the server to be partitioned into a set of protection spaces, each with its own set of authentication schemes from the authentication database. Read more on docs.microsoft.com. Used to enable server-side authentication on a URL group or server session. The HTTP_SERVER_AUTHENTICATION_INFO structure is included in the HTTP request if authentication has been configured on the associated URL group. The original HTTP authentication header received from the client is always included in the HTTP request, regardless of the authentication status. The HTTP_PROPERTY_FLAGS structure that specifies if the property is present. The supported authentication schemes. This can be one or more of the following: This doc was truncated. Read more on docs.microsoft.com. A Boolean value that indicates, if True, that the client application receives the server credentials for mutual authentication with the authenticated request. If False, the client application does not receive the credentials. Be aware that this option is set for all requests served by the associated request queue. Read more on docs.microsoft.com. A Boolean value that indicates, if True, that the finalized client context is serialized and passed to the application with the request. If False, the application does not receive the context. This handle can be used to query context attributes. A Boolean value that indicates, if True, that the NTLM credentials are not cached. If False, the default behavior is preserved. By default, HTTP caches the client context for Keep Alive (KA) connections for the NTLM scheme if the request did not originate from a proxy. Read more on docs.microsoft.com. Optional authentication flags. Can be one or more of the following possible values: This doc was truncated. Read more on docs.microsoft.com. The HTTP_SERVER_AUTHENTICATION_DIGEST_PARAMS structure that provides the domain and realm for the digest challenge. The HTTP_SERVER_AUTHENTICATION_BASIC_PARAMS structure that provides the realm for the basic challenge. Defines the properties that are configured by the HTTP Server API on a URL group, server session, or request queue. The HTTP_SERVER_PROPERTY enumeration types are used to set or query the configurations on a server session, URL group, or request queue. A member of this enumeration together with the associated configuration structure is used by HttpQueryRequestQueueProperty, HttpQueryServerSessionProperty, HttpQueryUrlGroupProperty, HttpSetRequestQueueProperty, HttpSetServerSessionProperty, and HttpSetUrlGroupProperty to define the configuration parameters. The authentication property enables server-side authentication for a URL group, or server session using the Basic, NTLM, Negotiate, and Digest authentication schemes. The HTTP_SERVER_AUTHENTICATION_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. The logging property enables logging for a server session or URL group. The HTTP_LOGGING_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. The QOS property enables settings affecting quality of service, such as limiting the maximum number of outstanding connections served for a URL group at any given time or limiting the response send bandwidth for a server session or URL group. The HTTP_QOS_SETTING_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. The timeouts property configures timeouts for a server session or URL group. The HTTP_TIMEOUT_LIMIT_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. The connections property limits the number of requests in the request queue. This is a ULONG. The connections property configures the state of a URL group, server session, or request queue. The HTTP_STATE_INFO structure contains the configuration data for this property for the URL group or server session. The request queue uses the HTTP_ENABLED_STATE enumeration to configure this property. Read more on docs.microsoft.com. The 503 verbosity property configures the verbosity level of 503 responses generated by the HTTP Server API for a request queue. The HTTP_503_RESPONSE_VERBOSITY enumeration contains the configuration data for this property. Read more on docs.microsoft.com. The binding property associates a URL group with a request queue. The HTTP_BINDING_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. The extended authentication property enables server-side authentication for a URL group, or server session using the Kerberos authentication scheme. The HTTP_SERVER_AUTHENTICATION_INFO structure contains the configuration data for this property. Read more on docs.microsoft.com. Listening endpoint property. This property implements authorization channel binding. The HTTP_CHANNEL_BIND_INFO structure contains the authorization details. Read more on docs.microsoft.com. Pointer to an HTTP_SERVICE_BINDING_TYPE value that indicates whether the data is in ASCII or Unicode. HTTP_SERVICE_BINDING_TYPE enumerated type specifies the string type for service names. Learn more about this API from docs.microsoft.com. No type. Unicode. ASCII Contains data about a Secure Sockets Layer (SSL) client certificate that can be used to determine whether the certificate is valid. An HTTP_SSL_CLIENT_CERT_INFO structure is pointed to by the pClientCertInfo member of the HTTP_SSL_INFO structure, and is used by the HttpReceiveClientCertificate function to return data about the client certificate through the pSslClientCertInfo parameter. Read more on docs.microsoft.com. Flags that indicate whether the certificate is valid. The possible values for this member are a SSPI Status Code returned from SSPI or one of the following flags from the dwError member of the CERT_CHAIN_POLICY_STATUS structure: Read more on docs.microsoft.com. The size, in bytes, of the certificate. A pointer to the actual certificate. A handle to an access token. If the HTTP_SERVICE_CONFIG_SSL_FLAG_USE_DS_MAPPER flag is set using the HttpSetServiceConfiguration function, and the client certificate was successfully mapped to an operating-system user account, then this member contains the handle to a valid access token. When the HTTP_SSL_CLIENT_CERT_INFO structure is no longer required, release this token explicitly by closing the handle. Read more on docs.microsoft.com. Reserved. Contains data for a connection that uses Secure Sockets Layer (SSL), obtained through the SSL handshake. An HTTP_SSL_INFO structure can be pointed to by the pSslInfo member of an HTTP_REQUEST structure. Read more on docs.microsoft.com. The size, in bytes, of the public key used to sign the server certificate. The size, in bytes, of the cipher key used to encrypt the current session. The size, in bytes, of the string pointed to by the pServerCertIssuer member not including the terminating null character. The size, in bytes, of the string pointed to by the pServerCertSubject member not including the terminating null character. A pointer to a null-terminated string of octets that specifies the name of the entity that issued the certificate. A pointer to a null-terminated string of octets that specifies the name of the entity to which the certificate belongs. A pointer to an HTTP_SSL_CLIENT_CERT_INFO structure that specifies the client certificate. Read more on docs.microsoft.com. If non-zero, indicates that the client certificate is already present locally. Defines the application-specific connection timeout limits. This structure is used in the HttpQueryServerSessionProperty, and HttpSetServerSessionProperty functions to set or query the connection timeouts. The following table lists the default timeouts. This doc was truncated. Read more on docs.microsoft.com. The HTTP_PROPERTY_FLAGS structure that specifies whether the property is present. The time, in seconds, allowed for the request entity body to arrive. The HTTP Server API turns on this timer when the request has an entity body. The timer expiration is initially set to the configured value. When the HTTP Server API receives additional data indications on the request, it resets the timer to give the connection another interval. Read more on docs.microsoft.com. The time, in seconds, allowed for the HTTP Server API to drain the entity body on a Keep-Alive connection. On a Keep-Alive connection, after the application has sent a response for a request and before the request entity body has completely arrived, the HTTP Server API starts draining the remainder of the entity body to reach another potentially pipelined request from the client. If the time to drain the remaining entity body exceeds the allowed period the connection is timed out. Read more on docs.microsoft.com. The time, in seconds, allowed for the request to remain in the request queue before the application picks it up. The time, in seconds, allowed for an idle connection. This timeout is only enforced after the first request on the connection is routed to the application. For more information, see the Remarks section. Read more on docs.microsoft.com. The time, in seconds, allowed for the HTTP Server API to parse the request header. This timeout is only enforced after the first request on the connection is routed to the application. For more information, see the Remarks section. Read more on docs.microsoft.com. The minimum send rate, in bytes-per-second, for the response. The default response send rate is 150 bytes-per-second. To disable this timer, set MinSendRate to MAXULONG. Read more on docs.microsoft.com. Specifies the addresses (local and remote) used for a particular HTTP connection. Although the pRemoteAddress and pLocalAddress members are formally declared as PSOCKADDR, they are in fact PSOCKADDR_IN or PSOCKADDR_IN6 types. Inspect the sa_family member, which is the same in all three structures, to determine how to access the address. If sa_family is equal to AF_INET, then the address is in IPv4 form and can be accessed by casting the members to PSOCKADDR_IN, but if sa_family equals AF_INET6, the address is in IPv6 form and you must cast them to PSOCKADDR_IN6 before accessing the address. Both pLocalAddress and pRemoteAddress are always of the same type; that is they are either both of type PSOCKADDR_IN or both of type PSOCKADDR_IN6. A pointer to the remote IP address associated with this connection. For more information about how to access this address, see the Remarks section. A pointer to the local IP address associated with this connection. For more information about how to access this address, see the Remarks section. Contains the name and value for a header in an HTTP request or response whose name does not appear in the enumeration. Learn more about this API from docs.microsoft.com. The size, in bytes, of the data pointed to by the pName member not counting a terminating null. The size, in bytes, of the data pointed to by the pRawValue member, in bytes. A pointer to a string of octets that specifies the header name. Use NameLength to determine the end of the string, rather than relying on a terminating null. A pointer to a string of octets that specifies the values for this header. Use RawValueLength to determine the end of the string, rather than relying on a terminating null. The HTTP_VERB enumeration type defines values that are used to specify known, standard HTTP verbs in the HTTP_REQUEST structure. The majority of these known verbs are documented in RFC 2616 and RFC 2518, as indicated below. Learn more about this API from docs.microsoft.com. Not relevant for applications; used only in kernel mode. Indicates that the application can examine the UnknownVerbLength and pUnknownVerb members of the HTTP_REQUEST structure to retrieve the HTTP verb for the request. This is the case in an HTTP/1.1 request when a browser client specifies a custom verb. Not relevant for applications; used only in kernel mode. The OPTIONS method requests information about the communication options and requirements associated with a URI. See page 52 of RFC 2616. Read more on docs.microsoft.com. The GET method retrieves the information or entity that is identified by the URI of the Request. If that URI refers to a script or other data-producing process, it is the data produced, not the text of the script, that is returned in the response. A GET method can be made conditional or partial by including a conditional or Range header field in the request. A conditional GET requests that the entity be sent only if all conditions specified in the header are met, and a partial GET requests only part of the entity, as specified in the Range header. Both of these forms of GET can help avoid unnecessary network traffic. See page 53 of RFC 2616. Read more on docs.microsoft.com. The HEAD method is identical to GET except that the server only returns message-headers in the response, without a message-body. The headers are the same as would be returned in response to a GET. See page 54 of RFC 2616. Read more on docs.microsoft.com. The POST method is used to post a new entity as an addition to a URI. The URI identifies an entity that consumes the posted data in some fashion. See page 54 of RFC 2616. Read more on docs.microsoft.com. The PUT method is used to replace an entity identified by a URI. See page 55 of RFC 2616. Read more on docs.microsoft.com. The DELETE method requests that a specified URI be deleted. See page 56 of RFC 2616. Read more on docs.microsoft.com. The TRACE method invokes a remote, application-layer loop-back of the request message. It allows the client to see what is being received at the other end of the request chain for diagnostic purposes. See page 56 of RFC 2616. Read more on docs.microsoft.com. The CONNECT method can be used with a proxy that can dynamically switch to tunneling, as in the case of SSL tunneling. See page 57 of RFC 2616. Read more on docs.microsoft.com. The TRACK method is used by Microsoft Cluster Server to implement a non-logged trace. The MOVE method requests a WebDAV operation equivalent to a copy (COPY), followed by consistency maintenance processing, followed by a delete of the source, where all three actions are performed atomically. When applied to a collection, "Depth" is assumed to be or must be specified as "infinity". See page 42 of RFC 2518. Read more on docs.microsoft.com. The COPY method requests a WebDAV operation that creates a duplicate of the source resource, identified by the Request URI, in the destination resource, identified by a URI specified in the Destination header. See page 37 of RFC 2518. Read more on docs.microsoft.com. The PROPFIND method requests a WebDAV operation that retrieves properties defined on the resource identified by the Request-URI. See page 24 of RFC 2518. Read more on docs.microsoft.com. The PROPPATCH method requests a WebDAV operation that sets and/or removes properties defined on the resource identified by the Request-URI. See page 31 of RFC 2518. Read more on docs.microsoft.com. The MKCOL method requests a WebDAV operation that creates a new collection resource at the location specified by the Request-URI. See page 33 of RFC 2518. Read more on docs.microsoft.com. The LOCK method requests a WebDAV operation that creates a lock as specified by the lockinfo XML element on the Request-URI. See page 45 of RFC 2518. Read more on docs.microsoft.com. The UNLOCK method requests a WebDAV operation that removes a lock, identified by a lock token in the Lock-Token request header, from the resource identified by the Request-URI, and from all other resources included in the lock. See page 51 of RFC 2518. Read more on docs.microsoft.com. The SEARCH method requests a WebDAV operation used by Microsoft Exchange to search folders. See the Internet Engineering Task Force (IETF) Internet Draft WebDAV SEARCH for more information, and the WebDAV Web site for possible updates. Read more on docs.microsoft.com. Terminates the enumeration; is not used to define a verb. Defines a version of the HTTP protocol that a request requires or a response provides. For more information about the HTTP protocol, see RFC 2616. The following macros define various versions of the HTTP protocol:"#define HTTP_VERSION_UNKNOWN { 0, 0 }""#define HTTP_VERSION_0_9 { 0, 9 }""#define HTTP_VERSION_1_0 { 1, 0 }""#define HTTP_VERSION_1_1 { 1, 1 }" The HTTP Server API provides a number of macros that can be used to evaluate the value of an HTTP_VERSION structure; For more information, see HTTP Server API Version 1.0 Macros.
Note  The HTTP Server API rejects a version of HTTP larger than 65,535 in either the major or minor portion. If a request includes such a version number, the HTTP Server API discards it and returns a response with status 400 ("Bad Request").
 
 Read more on docs.microsoft.com. Major version of the HTTP protocol. Minor version of the HTTP protocol. The length of the inline array. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. The length of the inline array. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. The **HRESULT** data type is the same as the [SCODE](scode.md) data type. An **HRESULT** value consists of the following fields: - A 1-bit code indicating severity, where zero represents success and 1 represents failure. - A 4-bit reserved value. - An 11-bit code indicating responsibility for the error or warning, also known as a facility code. - A 16-bit code describing the error or warning. Most MAPI interface methods and functions return **HRESULT** values to provide detailed cause formation. **HRESULT** values are also used widely in OLE interface methods. OLE provides several macros for converting between **HRESULT** values and **SCODE** values, another common data type for error handling. > [!NOTE] > In 64-bit MAPI, **HRESULT** is still a 32-bit value. For information about the OLE use of **HRESULT** values, see the *OLE Programmer's Reference*. For more information about the use of these values in MAPI, see [Error Handling](error-handling-in-mapi.md) and any of the following interface methods: [IABLogon::GetLastError](iablogon-getlasterror.md) [IMAPISupport::GetLastError](imapisupport-getlasterror.md) [IMAPIControl::GetLastError](imapicontrol-getlasterror.md) [IMAPITable::GetLastError](imapitable-getlasterror.md) [IMAPIProp::GetLastError](imapiprop-getlasterror.md) [IMAPIViewAdviseSink::OnPrint](imapiviewadvisesink-onprint.md) Read more on docs.microsoft.com. A pointer to the IErrorInfo interface that provides more information about the error. You can specify to use the current IErrorInfo interface, or new IntPtr(-1) to ignore the current IErrorInfo interface and construct the exception just from the error code. , if it does not reflect an error. A pointer to a null-terminated, constant, ANSI character string. A pointer to the first character in the string. The content should be considered readonly, as it was typed as constant in the SDK. Gets the number of characters up to the first null character (exclusive). Returns a with a copy of this character array, decoding as UTF-8. A , or if is . Returns a span of the characters in this string, up to the first null character (exclusive). A pointer to a null-terminated, constant character string. A pointer to the first character in the string. The content should be considered readonly, as it was typed as constant in the SDK. Gets the number of characters up to the first null character (exclusive). Returns a with a copy of this character array, up to the first null character (exclusive). A , or if is . Returns a span of the characters in this string, up to the first null character (exclusive). Returns a span of the characters in this string, up to the first null character (exclusive). Returns a span of the characters in this string, up to the first null character (exclusive). The length of the inline array. Gets a ref to an individual element of the inline array. ⚠ Important ⚠: When this struct is on the stack, do not let the returned reference outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. The length of the inline array. Gets a ref to an individual element of the inline array. ⚠ Important ⚠: When this struct is on the stack, do not let the returned reference outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Copies the fixed array to a new string up to the specified length regardless of whether there are null terminating characters. Thrown when is less than 0 or greater than . Copies the fixed array to a new string, stopping before the first null terminator character or at the end of the fixed array (whichever is shorter). Represents a Win32 handle that can be closed with . Contains extern methods from "ADVAPI32.dll". Contains extern methods from "HTTPAPI.dll". Contains extern methods from "KERNEL32.dll". Retrieves a copy of the security descriptor for an object specified by a handle. A handle to the object from which to retrieve security information. SE_OBJECT_TYPE enumeration value that indicates the type of object. A set of bit flags that indicate the type of security information to retrieve. This parameter can be a combination of the SECURITY_INFORMATION bit flags. Read more on docs.microsoft.com. A pointer to a variable that receives a pointer to the owner SID in the security descriptor returned in ppSecurityDescriptor. The returned pointer is valid only if you set the OWNER_SECURITY_INFORMATION flag. This parameter can be NULL if you do not need the owner SID. A pointer to a variable that receives a pointer to the primary group SID in the returned security descriptor. The returned pointer is valid only if you set the GROUP_SECURITY_INFORMATION flag. This parameter can be NULL if you do not need the group SID. A pointer to a variable that receives a pointer to the DACL in the returned security descriptor. The returned pointer is valid only if you set the DACL_SECURITY_INFORMATION flag. This parameter can be NULL if you do not need the DACL. A pointer to a variable that receives a pointer to the SACL in the returned security descriptor. The returned pointer is valid only if you set the SACL_SECURITY_INFORMATION flag. This parameter can be NULL if you do not need the SACL. A pointer to a variable that receives a pointer to the security descriptor of the object. When you have finished using the pointer, free the returned buffer by calling the LocalFree function. This parameter is required if any one of the ppsidOwner, ppsidGroup, ppDacl, or ppSacl parameters is not NULL. Read more on docs.microsoft.com. If the function succeeds, the return value is ERROR_SUCCESS. If the function fails, the return value is a nonzero error code defined in WinError.h. If the ppsidOwner, ppsidGroup, ppDacl, and ppSacl parameters are non-NULL, and the SecurityInfo parameter specifies that they be retrieved from the object, those parameters will point to the corresponding parameters in the security descriptor returned in ppSecurityDescriptor. To read the owner, group, or DACL from the object's security descriptor, the calling process must have been granted READ_CONTROL access when the handle was opened. To get READ_CONTROL access, the caller must be the owner of the object or the object's DACL must grant the access. To read the SACL from the security descriptor, the calling process must have been granted ACCESS_SYSTEM_SECURITY access when the handle was opened. The proper way to get this access is to enable the SE_SECURITY_NAME privilege in the caller's current token, open the handle for ACCESS_SYSTEM_SECURITY access, and then disable the privilege. For information about the security implications of enabling privileges, see Running with Special Privileges. You can use the GetSecurityInfo function with the following types of objects: This doc was truncated. Read more on docs.microsoft.com. Returns the length, in bytes, of a structurally valid security descriptor. The length includes the length of all associated structures. A pointer to the SECURITY_DESCRIPTOR structure whose length the function returns. The pointer is assumed to be valid. Read more on docs.microsoft.com. If the function succeeds, the function returns the length, in bytes, of the SECURITY_DESCRIPTOR structure. If the SECURITY_DESCRIPTOR structure is not valid, the return value is undefined. The minimum length of a security descriptor is SECURITY_DESCRIPTOR_MIN_LENGTH. A security descriptor of this length has no associated security identifiers (SIDs) or access control lists (ACLs). Read more on docs.microsoft.com. Adds the specified URL to the URL Group identified by the URL Group ID. The group ID for the URL group to which requests for the specified URL are routed. The URL group is created by the HttpCreateUrlGroup function. A pointer to a Unicode string that contains a properly formed UrlPrefix String that identifies the URL to be registered. If you are not running as an administrator, specify a port number greater than 1024, otherwise you may get an ERROR_ACCESS_DENIED error. The context that is associated with the URL registered in this call. The URL context is returned in the HTTP_REQUEST structure with every request received on the URL specified in the pFullyQualifiedUrl parameter. Reserved. Must be zero. If the function succeeds, it returns NO_ERROR If the function fails, it returns one of the following error codes. This doc was truncated. The HTTP Server API supports existing applications using version 1.0 URL registrations, however, new development with the HTTP Server API should use HttpAddUrlToUrlGroup; HttpAddUrl should not be used. An application can add multiple URLs to a URL group using repeated calls to HttpAddUrlToUrlGroup. Requests that match the specified URL are routed to the request queue associated with the URL group. For more information about how the HTTP Server API matches request URLs to registered URLs, see UrlPrefix Strings. Read more on docs.microsoft.com. The HttpCancelHttpRequest function cancels a specified reqest. A handle to the request queue from which the request came. The ID of the request to be canceled. For asynchronous calls, set pOverlapped to point to an OVERLAPPED structure; for synchronous calls, set it to NULL. If the function succeeds, it returns NO_ERROR. When the **HttpCancelHttpRequest** function is used to cancel a request, the underlying transport connection used for the request will be closed. Deletes the server session identified by the server session ID. The ID of the server session that is closed. If the function succeeds, it returns NO_ERROR If the function fails, it can return one of the following error codes. This doc was truncated. Applications must call HttpCloseUrlGroup before calling HttpCloseServerSession to close the all the URL Groups associated with the server session. Closes the URL Group identified by the URL Group ID. The ID of the URL Group that is deleted. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. Applications must call HttpCloseUrlGroup before calling HttpCloseServerSession to close the all URL Groups associated with the server session. Closes the handle to the specified request queue created by HttpCreateRequestQueue. The handle to the request queue that is closed. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function. Read more on docs.microsoft.com. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. Applications should not call CloseHandle on the request queue handle; instead, they should call HttpCloseRequestQueue to ensure that all the resources are released. Creates a new request queue or opens an existing request queue. An HTTPAPI_VERSION structure indicating the request queue version. For version 2.0, declare an instance of the structure and set it to the predefined value HTTPAPI_VERSION_2 before passing it to HttpCreateRequestQueue. The version must be 2.0; HttpCreateRequestQueue does not support version 1.0 request queues. Read more on docs.microsoft.com. The name of the request queue. The length, in bytes, cannot exceed MAX_PATH. The optional name parameter allows other processes to access the request queue by name. Read more on docs.microsoft.com. A pointer to the SECURITY_ATTRIBUTES structure that contains the access permissions for the request queue. This parameter must be NULL when opening an existing request queue. Read more on docs.microsoft.com. The flags parameter defines the scope of the request queue. This parameter can be one or more of the following: This doc was truncated. Read more on docs.microsoft.com. A pointer to a variable that receives a handle to the request queue. This parameter must contain a valid pointer; it cannot be NULL. If the function succeeds, it returns NO_ERROR If the function fails, it returns one of the following error codes. This doc was truncated. The HTTP Server API supports existing applications using the version 1.0 request queues, however, new development with the HTTP Server API should use HttpCreateRequestQueue to create request queues; HttpCreateHttpHandle should not be used. The version 2.0 API are only compatible with the version 2.0 request queues created by HttpCreateRequestQueue. The HTTP version 2 request queues require manual configuration; the application must create the URL Groups and associate one or more URL Group with the request queue by calling HttpSetUrlGroupProperty with the HttpServerBindingProperty. The application configures the request queue by calling HttpSetRequestQueueProperty with the desired configuration in the Property parameter. For more information about creating and configuring URL groups, see HttpCreateUrlGroup and HttpSetUrlGroupProperty. Security attributes may be supplied in pSecurityAttributes parameter only when the request queue is created. Only the application that creates the request queue can set Access Control Lists (ACLs) on the request queue handle to allow processes (other than the creator application) permission to open, receive requests, and send responses on the request queue handle. By default, applications are not allowed to open a request queue unless they have been granted permission in the ACL. The creator process can optionally use the HTTP_CREATE_REQUEST_QUEUE_FLAG_CONTROLLER flag to indicate that it does not want to receive http requests. HttpCreateRequestQueue allows applications to open an existing request queue with the HTTP_CREATE_REQUEST_QUEUE_FLAG_OPEN_EXISTING flag and retrieve the handle to the request queue. Non-controller applications can use this handle to perform HTTP I/O operations. Only the application that creates the request queue can set properties on it by calling the HttpSetRequestQueueProperty. The handle to the request queue created by HttpCreateRequestQueue must be closed by calling HttpCloseRequestQueue before the application terminates or when the session is no longer required. Applications must call HttpInitialize prior to calling HttpCreateRequestQueue. Read more on docs.microsoft.com. Creates a server session for the specified version. An HTTPAPI_VERSION structure that indicates the version of the server session. For version 2.0, declare an instance of the structure and set it to the predefined value HTTPAPI_VERSION_2 before passing it to HttpCreateServerSession. The version must be 2.0; HttpCreateServerSession does not support version 1.0 request queues. Read more on docs.microsoft.com. A pointer to the variable that receives the ID of the server session. Reserved. Must be zero. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. Server sessions own a set of URL Groups. They are top-level configuration containers for configuration information that applies to all of the URL Groups created under them. For more information about configuring a server session, see HttpSetServerSessionProperty. The HTTP Server API does not support asynchronous I/O for server sessions. When the server session is no longer required, or before the application terminates, application must delete the server session by calling HttpCloseServerSession. When a server session is deleted all of the associated URL Groups are also automatically deleted. Read more on docs.microsoft.com. Creates a URL Group under the specified server session. The identifier of the server session under which the URL Group is created. A pointer to the variable that receives the ID of the URL Group. Reserved. Must be zero. If the function succeeds, it returns NO_ERROR If the function fails, it returns one of the following error codes. This doc was truncated. URL Groups are configuration containers for a set of URLs. They are created under the server session and inherit the configuration settings of the server session. When a configuration parameter is set on the URL Group, it overrides the configuration set on the server session. For more information about the setting configurations for the URL Group, see HttpSetUrlGroupProperty. After the URL group is created it must be associated with a request queue to receive requests. To associate the URL Group with a request queue, the application calls HttpSetUrlGroupProperty with the HttpServerBindingProperty property. If this property is not set, matching requests for the URL Group are not delivered to a request queue and the HTTP Server API generates a 503 response. The URL Group association with a request queue is dynamic. The association with the servers session cannot be changed until either the server session or the URL Group is deleted. When a server session is deleted all of the associated URL Groups are also automatically closed. The URL Group is initially created as an empty group. URLs must be added to the group by calling HttpAddUrlToUrlGroup. This doc was truncated. Read more on docs.microsoft.com. Delegates a request from the source request queue to the target request queue. Type: \_In\_ **[HANDLE](/windows/win32/winprog/windows-data-types)** A handle to the source request queue. Read more on docs.microsoft.com. Type: \_In\_ **[HANDLE](/windows/win32/winprog/windows-data-types)** A handle to the target request queue. Read more on docs.microsoft.com. Type: \_In\_ **HTTP_REQUEST_ID** A unique request ID received with [HttpReceiveHttpRequest](/windows/win32/api/http/nf-http-httpreceivehttprequest). Read more on docs.microsoft.com. Type: \_In\_ **HTTP_URL_GROUP_ID** The url group id of the target url group. Read more on docs.microsoft.com. Type: \_In\_ **[ULONG](/windows/win32/winprog/windows-data-types)** The number of entries in the *PropertyInfoSet* array. Read more on docs.microsoft.com. Type: \_In\_ [**PHTTP_DELEGATE_REQUEST_PROPERTY_INFO](/windows/win32/api/http/ns-http-http_delegate_request_property_info)** An array of properties to be set on request when delegating. Read more on docs.microsoft.com. A **[ULONG](/windows/win32/winprog/windows-data-types)** containing an [NTSTATUS](/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) completion status. Retrieves a URL group ID for a URL and a request queue. Type: \_In\_ **[PCWSTR](/windows/win32/winprog/windows-data-types)** The URL whose URL group to query. Read more on docs.microsoft.com. Type: \_In\_ **[HANDLE](/windows/win32/winprog/windows-data-types)** The request queue associated with the URL group. Read more on docs.microsoft.com. Type: \_Out\_ **PHTTP_URL_GROUP_ID** The matching URL group ID. Read more on docs.microsoft.com. A **[ULONG](/windows/win32/winprog/windows-data-types)** containing an [NTSTATUS](/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) completion status. The HttpInitialize function initializes the HTTP Server API driver, starts it, if it has not already been started, and allocates data structures for the calling application to support response-queue creation and other operations. HTTP version. This parameter is an HTTPAPI_VERSION structure. For the current version, declare an instance of the structure and set it to the pre-defined value **HTTPAPI_VERSION_1** before passing it to HttpInitialize. Read more on docs.microsoft.com. This parameter is reserved, and must be NULL. If the function succeeds, then the return value is **NO_ERROR**. If the function fails, then the return value is one of the following error codes. This doc was truncated. Call HttpTerminate when the application completes. All the same flags that were passed to HttpInitialize in the Flags parameter must also be passed to HttpTerminate. An application can call HttpInitialize repeatedly, provided that each call to HttpInitialize is later matched by a corresponding call to HttpTerminate. Read more on docs.microsoft.com. Checks whether a particular feature is supported. Type: \_In\_ **[HTTP_FEATURE_ID](./ne-http-http_feature_id.md)** The identifier of the feature. Read more on docs.microsoft.com. `TRUE` if the feature is supported, otherwise `FALSE`. Receives additional entity body data for a specified HTTP request. The handle to the request queue from which to retrieve the specified entity body data. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function. Windows Server 2003 with SP1 and Windows XP with SP2:  The handle to the request queue is created by the HttpCreateHttpHandle function. Read more on docs.microsoft.com. The identifier of the HTTP request that contains the retrieved entity body. This value is returned in the RequestId member of the HTTP_REQUEST structure by a call to the HttpReceiveHttpRequest function. This value cannot be HTTP_NULL_ID. Read more on docs.microsoft.com. This parameter can be the following flag value. Windows Server 2003 with SP1 and Windows XP with SP2:  This parameter is reserved and must be zero. This doc was truncated. Read more on docs.microsoft.com. A pointer to a buffer that receives entity-body data. The size, in bytes, of the buffer pointed to by the pBuffer parameter. Optional. A pointer to a variables that receives the size, in bytes, of the entity body data returned in the pBuffer buffer. When making an asynchronous call using pOverlapped, set pBytesReceived to NULL. Otherwise, when pOverlapped is set to NULL, pBytesReceived must contain a valid memory address, and not be set to NULL. Read more on docs.microsoft.com. For asynchronous calls, set pOverlapped to point to an OVERLAPPED structure; for synchronous calls, set it to NULL. A synchronous call blocks until the entity-body data has been retrieved, 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. Read more on docs.microsoft.com. If the function succeeds, the return value is NO_ERROR. If the function is used asynchronously, a return value of ERROR_IO_PENDING indicates that the next request is not yet ready and is retrieved later through normal overlapped I/O completion mechanisms. If the function fails, the return value is one of the following error codes. This doc was truncated. To retrieve an entire entity body, an application is expected to call HttpReceiveRequestEntityBody, passing in new buffers, until the function returns ERROR_HANDLE_EOF. As long as a buffer full of entity-body data is copied successfully and there is still more entity-body data waiting to be retrieved, the function returns NO_ERROR. Read more on docs.microsoft.com. Removes the specified URL from the group identified by the URL Group ID. The ID of the URL group from which the URL specified in pFullyQualifiedUrl is removed. A pointer to a Unicode string that contains a properly formed UrlPrefix String that identifies the URL to be removed. When HTTP_URL_FLAG_REMOVE_ALL is passed in the Flags parameter, all of the existing URL registrations for the URL Group identified in UrlGroupId are removed from the group. In this case, pFullyQualifiedUrl must be NULL. Read more on docs.microsoft.com. The URL flags qualifying the URL that is removed. This can be one of the following flags: This doc was truncated. Read more on docs.microsoft.com. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. The HTTP Server API supports existing applications using the version 1.0 URL registrations, however, new development with the HTTP Server API should use HttpRemoveUrlFromUrlGroup; do not use HttpRemoveUrl. Applications should remove the URL added to the group by HttpAddUrlToUrlGroup, when the URL is no longer required. Read more on docs.microsoft.com. Sends an HTTP response to the specified HTTP request. A handle to the request queue from which the specified request was retrieved. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function. Windows Server 2003 with SP1 and Windows XP with SP2:  The handle to the request queue is created by the HttpCreateHttpHandle function. Read more on docs.microsoft.com. An identifier of the HTTP request to which this response corresponds. This value is returned in the RequestId member of the HTTP_REQUEST structure by a call to the HttpReceiveHttpRequest function. This value cannot be HTTP_NULL_ID. Read more on docs.microsoft.com. This parameter can be a combination of some of the following flag values. Those that are mutually exclusive are marked accordingly. This doc was truncated. Read more on docs.microsoft.com. A pointer to an HTTP_RESPONSE structure that defines the HTTP response. Read more on docs.microsoft.com. A pointer to the HTTP_CACHE_POLICY structure used to cache the response. Windows Server 2003 with SP1 and Windows XP with SP2:  This parameter is reserved and must be NULL. Read more on docs.microsoft.com. Optional. A pointer to a variable that receives the number, in bytes, sent if the function operates synchronously. When making an asynchronous call using pOverlapped, set pBytesSent to NULL. Otherwise, when pOverlapped is set to NULL, pBytesSent must contain a valid memory address and not be set to NULL. Read more on docs.microsoft.com. This parameter is reserved and must be NULL. This parameter is reserved and must be zero. For asynchronous calls, set pOverlapped to point to an OVERLAPPED structure; for synchronous calls, set to NULL. A synchronous call blocks until all response data specified in the pHttpResponse parameter is sent, 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. Read more on docs.microsoft.com. A pointer to the HTTP_LOG_DATA structure used to log the response. Pass a pointer to the HTTP_LOG_FIELDS_DATA structure and cast it to PHTTP_LOG_DATA. Be aware that even when logging is enabled on a URL Group, or server session, the response will not be logged unless the application supplies the log fields data structure. Windows Server 2003 and Windows XP with SP2:  This parameter is reserved and must be NULL. Windows Vista and Windows Server 2008:  This parameter is new for Windows Vista, and Windows Server 2008 Read more on docs.microsoft.com. If the function succeeds, the function returns NO_ERROR. If the function is used asynchronously, a return value of ERROR_IO_PENDING indicates that the next request is not yet ready and is retrieved later through normal overlapped I/O completion mechanisms. If the function fails, it returns one of the following error codes. This doc was truncated. The HttpSendHttpResponse function is used to create and send a response header, and the HttpSendResponseEntityBody function can be used to send entity-body data as required. If neither a content-length header nor a transfer-encoding header is included with the response, the application must indicate the end of the response by explicitly closing the connection by using the HTTP_SEND_RESPONSE_DISCONNECT flag. If an application specifies a "Server:" header in a response, using the HttpHeaderServer identifier in the HTTP_KNOWN_HEADER structure, that specified value is placed as the first part of the header, followed by a space and then "Microsoft-HTTPAPI/1.0". If no server header is specified, HttpSendHttpResponse supplies "Microsoft-HTTPAPI/1.0" as the server header.
Note  The HttpSendHttpResponse and HttpSendResponseEntityBody function must not be called simultaneously from different threads on the same RequestId.
 
 Read more on docs.microsoft.com. Sends entity-body data associated with an HTTP response. A handle to the request queue from which the specified request was retrieved. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function. Windows Server 2003 with SP1 and Windows XP with SP2:  The handle to the request queue is created by the HttpCreateHttpHandle function. Read more on docs.microsoft.com. An identifier of the HTTP request to which this response corresponds. This value is returned in the RequestId member of the HTTP_REQUEST structure by a call to the HttpReceiveHttpRequest function. It cannot be HTTP_NULL_ID. Read more on docs.microsoft.com. A parameter that can include one of the following mutually exclusive flag values. This doc was truncated. Read more on docs.microsoft.com. A number of structures in the array pointed to by pEntityChunks. This count cannot exceed 9999. A pointer to an array of HTTP_DATA_CHUNK structures to be sent as entity-body data. Read more on docs.microsoft.com. Optional. A pointer to a variable that receives the number, in bytes, sent if the function operates synchronously. When making an asynchronous call using pOverlapped, set pBytesSent to NULL. Otherwise, when pOverlapped is set to NULL, pBytesSent must contain a valid memory address, and not be set to NULL. Read more on docs.microsoft.com. This parameter is reserved and must be NULL. This parameter is reserved and must be zero. For asynchronous calls, set pOverlapped to point to an OVERLAPPED structure; for synchronous calls, set it to NULL. A synchronous call blocks until all response data specified in the pEntityChunks parameter is sent, 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. Read more on docs.microsoft.com. A pointer to the HTTP_LOG_DATA structure used to log the response. Pass a pointer to the HTTP_LOG_FIELDS_DATA structure and cast it to PHTTP_LOG_DATA. Be aware that even when logging is enabled on a URL Group, or server session, the response will not be logged unless the application supplies the log fields data structure. Windows Server 2003 and Windows XP with SP2:  This parameter is reserved and must be NULL. Windows Vista and Windows Server 2008:  This parameter is new for Windows Vista, and Windows Server 2008 Read more on docs.microsoft.com. If the function succeeds, the return value is NO_ERROR. If the function is used asynchronously, a return value of ERROR_IO_PENDING indicates that the next request is not yet ready and is retrieved later through normal overlapped I/O completion mechanisms. If the function fails, the return value is one of the following error codes. This doc was truncated. If neither a Content-length header nor a Transfer-encoding header is included in the response headers, the application must indicate the end of the response by explicitly closing the connection using the HTTP_SEND_RESPONSE_DISCONNECT flag.
Note  HttpSendResponseEntityBody (or HttpSendHttpResponse) and HttpSendResponseEntityBody must not be called simultaneously from different threads on the same RequestId.
 
 Read more on docs.microsoft.com. Sets a new property or modifies an existing property on the request queue identified by the specified handle. The handle to the request queue on which the property is set. A request queue is created and its handle returned by a call to the HttpCreateRequestQueue function. Read more on docs.microsoft.com. A member of the HTTP_SERVER_PROPERTY enumeration describing the property type that is set. This must be one of the following: This doc was truncated. Read more on docs.microsoft.com. A pointer to the buffer that contains the property information. This doc was truncated. Read more on docs.microsoft.com. The length, in bytes, of the buffer pointed to by the pPropertyInformation parameter. Reserved. Must be zero. Reserved. Must be NULL. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. Learn more about this API from docs.microsoft.com. Sets a new property or modifies an existing property on the specified URL Group. The ID of the URL Group for which the property is set. A member of the HTTP_SERVER_PROPERTY enumeration that describes the property type that is modified or set. This can be one of the following: This doc was truncated. Read more on docs.microsoft.com. A pointer to the buffer that contains the property information. This doc was truncated. Read more on docs.microsoft.com. The length, in bytes, of the buffer pointed to by the pPropertyInformation parameter. If the function succeeds, it returns NO_ERROR. If the function fails, it returns one of the following error codes. This doc was truncated. After the URL Group is created it must be associated with a request queue to receive requests. To associate the URL Group with a request queue, the application calls HttpSetUrlGroupProperty with the HttpServerBindingProperty property. If this property is not set, matching requests for the URL Group are not delivered to a request queue and the HTTP Server API generates a 503 response. Closes an open object handle. A valid handle to an open object. If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError. If the application is running under a debugger, the function will throw an exception if it receives either a handle value that is not valid or a pseudo-handle value. This can happen if you close a handle twice, or if you call CloseHandle on a handle returned by the FindFirstFile function instead of calling the FindClose function. The CloseHandle function closes handles to the following objects: This doc was truncated. Read more on docs.microsoft.com. Sets the notification modes for a file handle, allowing you to specify how completion notifications work for the specified file. A handle to the file. The modes to be set. One or more modes can be set at the same time; however, after a mode has been set for a file handle, it cannot be removed. This doc was truncated. Read more on docs.microsoft.com. Returns nonzero if successful or zero otherwise. To get extended error information, call GetLastError. To compile an application that uses this function, define the _WIN32_WINNT macro as 0x0600 or later. For more information, see Using the Windows Headers. In Windows 8 and Windows Server 2012, this function is supported by the following technologies. This doc was truncated. Read more on docs.microsoft.com. Frees the specified local memory object and invalidates its handle. A handle to the local memory object. This handle is returned by either the LocalAlloc or LocalReAlloc function. It is not safe to free memory allocated with GlobalAlloc. Read more on docs.microsoft.com. If the function succeeds, the return value is NULL. If the function fails, the return value is equal to a handle to the local memory object. To get extended error information, call GetLastError. If the process tries to examine or modify the memory after it has been freed, heap corruption may occur or an access violation exception (EXCEPTION_ACCESS_VIOLATION) may be generated. If the hMem parameter is NULL, LocalFree ignores the parameter and returns NULL. The LocalFree function will free a locked memory object. A locked memory object has a lock count greater than zero. The LocalLock function locks a local memory object and increments the lock count by one. The LocalUnlock function unlocks it and decrements the lock count by one. To get the lock count of a local memory object, use the LocalFlags function. If an application is running under a debug version of the system, LocalFree will issue a message that tells you that a locked object is being freed. If you are debugging the application, LocalFree will enter a breakpoint just before freeing a locked object. This allows you to verify the intended behavior, then continue execution. Read more on docs.microsoft.com. The length of the inline array. Gets a ref to an individual element of the inline array. ⚠ Important ⚠: When this struct is on the stack, do not let the returned reference outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it. Gets this inline array as a span. ⚠ Important ⚠: When this struct is on the stack, do not let the returned span outlive the stack frame that defines it.