HTTPRemoveUrlFromUrlGroup 函式 (http.h)

發行項
02/26/2024

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

拿掉 pFullyQualifiedUrl 中所指定 URL 的 URL 群組識別碼。

[in] pFullyQualifiedUrl

Unicode 字串的指標，其中包含正確格式的 UrlPrefix String ，可識別要移除的 URL。

在 Flags 參數中傳遞HTTP_URL_FLAG_REMOVE_ALL時，UrlGroupId 中所識別 URL 群組的所有現有 URL 註冊都會從群組中移除。在此情況下， 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 群組註冊。

備註

HTTP Server API 支援使用 1.0 版 URL 註冊的現有應用程式，不過，使用 HTTP Server API 的新開發應該使用 HttpRemoveUrlFromUrlGroup;請勿使用 HttpRemoveUrl。

當不再需要 URL 時，應用程式應該移除由 HttpAddUrlToUrlGroup 新增至群組的 URL。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	http.h
程式庫	Httpapi.lib
Dll	Httpapi.dll