Função HttpRemoveUrlFromUrlGroup (http.h)

Artigo
02/26/2024

A função HttpRemoveUrlFromUrlGroup remove a URL especificada do grupo identificado pela ID do Grupo de URL. Essa função remove uma ou todas as URLs do grupo.

Essa função substitui a função HTTP versão 1.0 HttpRemoveUrl .

Sintaxe

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

Parâmetros

[in] UrlGroupId

A ID do grupo de URL do qual a URL especificada em pFullyQualifiedUrl é removida.

[in] pFullyQualifiedUrl

Um ponteiro para uma cadeia de caracteres Unicode que contém uma Cadeia de Caracteres UrlPrefix formada corretamente que identifica a URL a ser removida.

Quando HTTP_URL_FLAG_REMOVE_ALL é passado no parâmetro Flags , todos os registros de URL existentes para o Grupo de URL identificado em UrlGroupId são removidos do grupo. Nesse caso, pFullyQualifiedUrl deve ser NULL.

[in] Flags

Os sinalizadores de URL qualificam a URL removida. Esse pode ser um dos seguintes sinalizadores:

Sinalizador de URL	Significado
HTTP_URL_FLAG_REMOVE_ALL	Remove todas as URLs registradas no momento com o Grupo de URLs.

Retornar valor

Se a função for bem-sucedida, ela retornará NO_ERROR.

Se a função falhar, ela retornará um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	O Grupo de URLs não existe. O parâmetro Flags contém uma combinação inválida de sinalizadores. O sinalizador HTTP_URL_FLAG_REMOVE_ALL foi definido e o parâmetro pFullyQualifiedUrl não foi definido como NULL. O aplicativo não tem permissão para remover URLs do Grupo. Somente o aplicativo que criou o Grupo de URL pode remover URLs.
ERROR_ACCESS_DENIED	O processo de chamada não tem permissão para desregistrar a URL.
ERROR_FILE_NOT_FOUND	A URL especificada não está registrada com o Grupo de URLs.

Valor

Significado

ERROR_INVALID_PARAMETER

O Grupo de URLs não existe.

O parâmetro Flags contém uma combinação inválida de sinalizadores.

O sinalizador HTTP_URL_FLAG_REMOVE_ALL foi definido e o parâmetro pFullyQualifiedUrl não foi definido como NULL.

O aplicativo não tem permissão para remover URLs do Grupo. Somente o aplicativo que criou o Grupo de URL pode remover URLs.

ERROR_ACCESS_DENIED

O processo de chamada não tem permissão para desregistrar a URL.

ERROR_FILE_NOT_FOUND

A URL especificada não está registrada com o Grupo de URLs.

Comentários

A API do servidor HTTP dá suporte a aplicativos existentes usando os registros de URL da versão 1.0, no entanto, o novo desenvolvimento com a API do servidor HTTP deve usar HttpRemoveUrlFromUrlGroup; não use HttpRemoveUrl.

Os aplicativos devem remover a URL adicionada ao grupo por HttpAddUrlToUrlGroup, quando a URL não for mais necessária.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	http.h
Biblioteca	Httpapi.lib
DLL	Httpapi.dll