Skip to content

Update nf-http-httpinitialize.md #906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 17, 2021
Merged

Update nf-http-httpinitialize.md #906

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd1c44d
Update nf-http-httpinitialize.md
shirhatti Sep 17, 2021
0da3252
Oops. Wrong function 😅
shirhatti Sep 17, 2021
070075b
Edit pass
stevewhims Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions sdk-api-src/content/http/nf-http-httpinitialize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,16 @@ api_name:

# HttpInitialize function


## -description

The
<b>HttpInitialize</b> 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. Call this function before calling any other functions in the HTTP Server API.
The <b>HttpInitialize</b> 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. Call this function before calling any other functions in the HTTP Server API.

## -parameters

### -param Version [in]

HTTP version. This parameter is an
<a href="/windows/desktop/api/http/ns-http-httpapi_version">HTTPAPI_VERSION</a> 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
<a href="/windows/win32/api/http/ns-http-httpapi_version">HTTPAPI_VERSION</a> 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
<b>HttpInitialize</b>.

### -param Flags [in]
Expand All @@ -77,9 +75,10 @@ Initialization options, which can include one or both of the following values.
</td>
<td width="60%">
Perform initialization for applications that use the HTTP configuration functions,
<a href="/windows/desktop/api/http/nf-http-httpsetserviceconfiguration">HttpSetServiceConfiguration</a>,
<a href="/windows/desktop/api/http/nf-http-httpqueryserviceconfiguration">HttpQueryServiceConfiguration</a> and
<a href="/windows/desktop/api/http/nf-http-httpdeleteserviceconfiguration">HttpDeleteServiceConfiguration</a>.
<a href="/windows/win32/api/http/nf-http-httpsetserviceconfiguration">HttpSetServiceConfiguration</a>,
<a href="/windows/win32/api/http/nf-http-httpqueryserviceconfiguration">HttpQueryServiceConfiguration</a>,
<a href="/windows/win32/api/http/nf-http-httpdeleteserviceconfiguration">HttpDeleteServiceConfiguration</a>, and
<a href="/windows/win32/api/http/nf-http-httpisfeaturesupported">HttpIsFeatureSupported</a>.

</td>
</tr>
Expand All @@ -97,13 +96,13 @@ Perform initialization for applications that use the HTTP Server API.

### -param pReserved [in, out]

This parameter is reserved and must be <b>NULL</b>.
This parameter is reserved, and must be <b>NULL</b>.

## -returns

If the function succeeds, the return value is NO_ERROR.
If the function succeeds, then the return value is **NO_ERROR**.

If the function fails, the return value is one of the following error codes.
If the function fails, then the return value is one of the following error codes.

<table>
<tr>
Expand All @@ -128,7 +127,7 @@ The <i>Flags</i> parameter contains an unsupported value.
</dl>
</td>
<td width="60%">
A <a href="/windows/desktop/Debug/system-error-codes">system error code</a> defined in WinError.h.
A <a href="/windows/win32/debug/system-error-codes">system error code</a> defined in WinError.h.

</td>
</tr>
Expand All @@ -137,7 +136,7 @@ A <a href="/windows/desktop/Debug/system-error-codes">system error code</a> defi
## -remarks

Call
<a href="/windows/desktop/api/http/nf-http-httpterminate">HttpTerminate</a> when the application completes. All the same flags that were passed to
<a href="/windows/win32/api/http/nf-http-httpterminate">HttpTerminate</a> when the application completes. All the same flags that were passed to
<b>HttpInitialize</b> in the <i>Flags</i> parameter must also be passed to
<b>HttpTerminate</b>. An application can call
<b>HttpInitialize</b> repeatedly, provided that each call to
Expand All @@ -146,8 +145,5 @@ Call

## -see-also

<a href="/windows/desktop/Http/http-server-api-version-1-0-functions">HTTP Server API Version 1.0 Functions</a>



<a href="/windows/desktop/api/http/nf-http-httpterminate">HttpTerminate</a>
* <a href="/windows/win32/http/http-server-api-version-1-0-functions">HTTP Server API Version 1.0 Functions</a>
* <a href="/windows/win32/api/http/nf-http-httpterminate">HttpTerminate</a>