Функция HttpRemoveUrlFromUrlGroup (http.h)

Статья
08/24/2023

Функция HttpRemoveUrlFromUrlGroup удаляет указанный URL-адрес из группы, определяемой идентификатором группы URL-адресов. Эта функция удаляет один или все URL-адреса из группы.

Эта функция заменяет функцию HTTP версии 1.0 HttpRemoveUrl .

Синтаксис

HTTPAPI_LINKAGE ULONG HttpRemoveUrlFromUrlGroup(
  [in] HTTP_URL_GROUP_ID UrlGroupId,
  [in] PCWSTR            pFullyQualifiedUrl,
  [in] ULONG             Flags
);

Параметры

[in] UrlGroupId

Идентификатор группы URL-адресов, из которой удаляется URL-адрес, указанный в pFullyQualifiedUrl .

[in] pFullyQualifiedUrl

Указатель на строку Юникода, содержащую правильно сформированную строку UrlPrefix, идентифицирующий удаляемые URL-адреса.

При передаче HTTP_URL_FLAG_REMOVE_ALL в параметре Flags все существующие регистрации URL-адресов для группы URL-адресов, определенной в Параметре UrlGroupId , удаляются из группы. В этом случае pFullyQualifiedUrl должен иметь значение NULL.

[in] Flags

Флаги URL-адресов, определяющие удаляемые URL-адреса. Это может быть один из следующих флагов:

Флаг URL-адреса	Значение
HTTP_URL_FLAG_REMOVE_ALL	Удаляет все URL-адреса, зарегистрированные в группе URL-адресов.

Возвращаемое значение

Если функция завершается успешно, она возвращает NO_ERROR.

Если функция завершается сбоем, она возвращает один из следующих кодов ошибок.

Значение	Значение
ERROR_INVALID_PARAMETER	Группа URL-адресов не существует. Параметр Flags содержит недопустимое сочетание флагов. Флаг HTTP_URL_FLAG_REMOVE_ALL установлен, а параметру pFullyQualifiedUrl не присвоено значение NULL. Приложение не имеет разрешения на удаление URL-адресов из группы. Только приложение, создающее группу URL-адресов, может удалять URL-адреса.
ERROR_ACCESS_DENIED	Вызывающий процесс не имеет разрешения на отмену регистрации URL-адреса.
ERROR_FILE_NOT_FOUND	Указанный URL-адрес не зарегистрирован в группе URL-адресов.

Значение

ERROR_INVALID_PARAMETER

Группа URL-адресов не существует.

Параметр Flags содержит недопустимое сочетание флагов.

Флаг HTTP_URL_FLAG_REMOVE_ALL установлен, а параметру pFullyQualifiedUrl не присвоено значение NULL.

Приложение не имеет разрешения на удаление URL-адресов из группы. Только приложение, создающее группу URL-адресов, может удалять URL-адреса.

ERROR_ACCESS_DENIED

Вызывающий процесс не имеет разрешения на отмену регистрации URL-адреса.

ERROR_FILE_NOT_FOUND

Указанный URL-адрес не зарегистрирован в группе URL-адресов.

API HTTP-сервера поддерживает существующие приложения, использующие регистрацию URL-адресов версии 1.0, однако новая разработка с помощью API HTTP-сервера должна использовать HttpRemoveUrlFromUrlGroup; не используйте HttpRemoveUrl.

Приложения должны удалить URL-адрес, добавленный в группу httpAddUrlToUrlGroup, если URL-адрес больше не требуется.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	http.h
Библиотека	Httpapi.lib
DLL	Httpapi.dll