HttpCreateHttpHandle function

The HttpCreateHttpHandle function creates an HTTP request queue for the calling application and returns a handle to it.

Starting with HTTP Server API Version 2.0, applications should call HttpCreateRequestQueue to create the request queue; HttpCreateHttpHandle should not be used.

Syntax


ULONG HttpCreateHttpHandle(
  _Out_       PHANDLE pReqQueueHandle,
  _Reserved_  ULONG Reserved
);

Parameters

pReqQueueHandle [out]

A pointer to a variable that receives a handle to the request queue.

Reserved [in]

Reserved. This parameter must be zero.

Return value

If the function succeeds, the return value is NO_ERROR.

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

ValueMeaning
ERROR_DLL_INIT_FAILED

The calling application did not call HttpInitialize before calling this function.

Other

A system error code defined in WinError.h.

 

Remarks

The request queue enables the calling application to receive requests for particular URLs. The calling application uses the HttpAddUrl function to specify the URL for which it should receive requests.

An application should use a single request queue to receive requests. Using multiple request queues from a single process does not increase response time or throughput.

When an application has finished receiving requests, it should call the CloseHandle function to close the handle.

Requirements

Minimum supported client

Windows Vista, Windows XP with SP2 [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Http.h

Library

Httpapi.lib

DLL

Httpapi.dll

See also

HTTP Server API Version 1.0 Functions
HttpAddUrl
HttpCreateRequestQueue

 

 

Community Additions

ADD
Show:
© 2014 Microsoft