HTTPAddUrlToUrlGroup 函式 (http.h)

發行項
02/26/2024

HttpAddUrlToUrlGroup 函式會將指定的 URL 新增至 URL 群組識別碼所識別的 URL 群組。

此函式會取代 HTTP 1.0 版 HttpAddUrl 函式。

語法

HTTPAPI_LINKAGE ULONG HttpAddUrlToUrlGroup(
  [in]           HTTP_URL_GROUP_ID UrlGroupId,
  [in]           PCWSTR            pFullyQualifiedUrl,
  [in, optional] HTTP_URL_CONTEXT  UrlContext,
  [in]           ULONG             Reserved
);

參數

[in] UrlGroupId

路由傳送指定 URL 要求之 URL 群組的群組識別碼。 URL 群組是由 HttpCreateUrlGroup 函式所建立。

[in] pFullyQualifiedUrl

Unicode 字串的指標，其中包含正確格式的 UrlPrefix String ，可識別要註冊的 URL。如果您不是以系統管理員身分執行，請指定大於 1024 的埠號碼，否則您可能會收到ERROR_ACCESS_DENIED錯誤。

[in, optional] UrlContext

與在此呼叫中註冊的 URL 相關聯的內容。 URL 內容會在 HTTP_REQUEST 結構中傳回，並在 pFullyQualifiedUrl 參數中指定的 URL 上收到每個要求。

[in] Reserved

保留的。必須為零。

傳回值

如果函式成功，它會傳回 NO_ERROR

如果函式失敗，它會傳回下列其中一個錯誤碼。

值	意義
ERROR_INVALID_PARAMETER	UrlGroupId 不存在。保留參數不是零。應用程式沒有將 URL 新增至群組的許可權。只有建立URL群組的應用程式可以新增URL。
ERROR_ACCESS_DENIED	呼叫進程沒有註冊 URL 的許可權。
ERROR_ALREADY_EXISTS	指定的 URL 與現有的註冊衝突。

值

意義

ERROR_INVALID_PARAMETER

UrlGroupId 不存在。

保留參數不是零。

應用程式沒有將 URL 新增至群組的許可權。只有建立URL群組的應用程式可以新增URL。

ERROR_ACCESS_DENIED

呼叫進程沒有註冊 URL 的許可權。

ERROR_ALREADY_EXISTS

指定的 URL 與現有的註冊衝突。

備註

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

應用程式可以使用對 HttpAddUrlToUrlGroup 的重複呼叫，將多個 URL 新增至 URL 群組。符合指定 URL 的要求會路由傳送至與 URL 群組相關聯的要求佇列。如需 HTTP 伺服器 API 如何比對要求 URL 與已註冊 URL 的詳細資訊，請參閱 UrlPrefix 字串。

規格需求

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