Edit

HttpRemoveUrl function (http.h)

  • Article

The HttpRemoveUrl function causes the system to stop routing requests that match a specified UrlPrefix string to a specified request queue.

Starting with HTTP Server API Version 2.0, applications should call HttpRemoveUrlFromUrlGroup to register a URL; HttpRemoveUrl should not be used.

Syntax

HTTPAPI_LINKAGE ULONG HttpRemoveUrl(
  [in] HANDLE RequestQueueHandle,
  [in] PCWSTR FullyQualifiedUrl
);

Parameters

[in] RequestQueueHandle

The handle to the request queue from which the URL registration is to be removed. 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.

[in] FullyQualifiedUrl

A pointer to a UrlPrefix string registered to the specified request queue. This string must be identical to the one passed to HttpAddUrl to register the UrlPrefix; even a nomenclature change in an IPv6 address is not accepted.

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.

Value Meaning
ERROR_ACCESS_DENIED
 The calling application does not have permission to remove the URL.
ERROR_INVALID_PARAMETER
 One or more of the supplied parameters is in an unusable form.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
ERROR_FILE_NOT_FOUND
 The specified UrlPrefix could not be found in the registration database.
Other
 A system error code defined in WinError.h.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header http.h
Library Httpapi.lib
DLL Httpapi.dll

See also

HTTP Server API Version 1.0 Functions

HttpAddUrl

HttpRemoveUrlFromUrlGroup