dhcpV4RemoveOptionValue 函式 (dhcpsapi.h)

  • 發行項

DhcpV4RemoveOptionValue函式會從 DHCP 伺服器上定義的範圍中移除選項值。 此函式允許呼叫端指定選項的原則，藉此擴充 DhcpRemoveOptionValueV5 所提供的功能。

語法

DWORD DHCP_API_FUNCTION DhcpV4RemoveOptionValue(
  [in, optional] LPWSTR                   ServerIpAddress,
  [in]           DWORD                    Flags,
  [in]           DHCP_OPTION_ID           OptionID,
  [in, optional] LPWSTR                   PolicyName,
  [in, optional] LPWSTR                   VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO ScopeInfo
);

參數

[in, optional] ServerIpAddress

Null 終止的 Unicode 字串指標，表示 DHCP 伺服器的 IP 位址或主機名稱。

[in] Flags

指出選項值是針對特定或預設廠商。

Flags 意義
0x00000000
 預設廠商會移除選項值。
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 特定廠商會移除選項值。 廠商位於 VendorName中。

[in] OptionID

DHCP_OPTION_ID 結構，指定要移除之選項值的選項碼。 您可以在 找到標準 DHCP 和 BOOTP 選項碼的完整清單 http://www.ietf.org/rfc/rfc2132.txt

[in, optional] PolicyName

Null 終止的 Unicode 字串，表示要移除之選項值子網內的原則名稱。 子網是由ScopeInfo的SubnetScopeInfo成員所識別。

[in, optional] VendorName

Null 終止的 Unicode 字串，表示 選項的廠商。 此參數是選擇性的，當旗標未DHCP_FLAGS_OPTION_IS_VENDOR時，應該是Null。 如果未指定廠商，則會為預設廠商設定選項值。

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO結構的指標，其中包含要移除之選項值範圍的相關資訊

傳回值

如果函式成功，則會傳回 ERROR_SUCCESS。

如果函式失敗，它會從 DHCP 伺服器管理 API 錯誤碼傳回下列其中一個錯誤碼或錯誤碼。

值 意義
ERROR_INVALID_PARAMETER
 一或多個參數無效。
ERROR_DHCP_CLASS_NOT_FOUND
 使用的類別名稱未知或不正確。
ERROR_DHCP_POLICY_NOT_FOUND
 指定的原則名稱不存在。
ERROR_DHCP_OPTION_NOT_PRESENT
 指定的選項定義不存在於 DHCP 伺服器資料庫，或指定的原則上未針對指定的選項識別碼設定任何值。
ERROR_DHCP_SUBNET_NOT_PRESENT
 指定的 IPv4 子網不存在。

需求

   
最低支援的用戶端 都不支援
最低支援的伺服器 Windows Server 2012 [僅限傳統型應用程式]
目標平台 Windows
標頭 dhcpsapi.h
程式庫 Dhcpsapi.lib
Dll Dhcpsapi.dll

另請參閱

DhcpV4GetAllOptionValues

DhcpV4GetOptionValue

DhcpV4SetOptionValue

DhcpV4SetOptionValues