UID

title

description

helpviewer_keywords

old-location

tech.root

ms.assetid

ms.date

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

req.redist

ms.custom

f1_keywords

dev_langs

topic_type

api_type

api_location

api_name

NF:http.HttpRemoveUrlFromUrlGroup

HttpRemoveUrlFromUrlGroup function (http.h)

Removes the specified URL from the group identified by the URL Group ID.

HTTP_URL_FLAG_REMOVE_ALL

HttpRemoveUrlFromUrlGroup

HttpRemoveUrlFromUrlGroup function [HTTP]

http.httpremoveurlfromurlgroup

http/HttpRemoveUrlFromUrlGroup

http\httpremoveurlfromurlgroup.htm

http

9c5c1fec-f3b4-414f-a841-e360f5f4e4db

12/05/2018

HTTP_URL_FLAG_REMOVE_ALL, HttpRemoveUrlFromUrlGroup, HttpRemoveUrlFromUrlGroup function [HTTP], http.httpremoveurlfromurlgroup, http/HttpRemoveUrlFromUrlGroup

http.h

Windows

Windows Vista [desktop apps only]

Windows Server 2008 [desktop apps only]

Httpapi.lib

Httpapi.dll

Windows

19H1

HttpRemoveUrlFromUrlGroup

http/HttpRemoveUrlFromUrlGroup

c++

APIRef

kbSyntax

DllExport

Httpapi.dll

HttpRemoveUrlFromUrlGroup

HttpRemoveUrlFromUrlGroup function

-description

The HttpRemoveUrlFromUrlGroup function removes the specified URL from the group identified by the URL Group ID. This function removes one, or all, of the URLs from the group.

This function replaces the HTTP version 1.0 HttpRemoveUrl function.

-parameters

-param UrlGroupId [in]

The ID of the URL group from which the URL specified in pFullyQualifiedUrl is removed.

-param pFullyQualifiedUrl [in]

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.

-param Flags [in]

The URL flags qualifying the URL that is removed. This can be one of the following flags:

URL Flag	Meaning
HTTP_URL_FLAG_REMOVE_ALL	Removes all of the URLs currently registered with the URL Group.

-returns

If the function succeeds, it returns NO_ERROR.

If the function fails, it returns one of the following error codes.

Value

Meaning

ERROR_INVALID_PARAMETER

The URL Group does not exist.

The Flags parameter contains an invalid combination of flags.

The HTTP_URL_FLAG_REMOVE_ALL flag was set and the pFullyQualifiedUrl parameter was not set to NULL.

The application does not have permission to remove URLs from the Group. Only the application that created the URL Group can remove URLs.

ERROR_ACCESS_DENIED

The calling process does not have permission to deregister the URL.

ERROR_FILE_NOT_FOUND

The specified URL is not registered with the URL Group.

-remarks

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.