dhcpSetOptionValue 函式 (dhcpsapi.h)

  • 發行項

DhcpSetOptionValue 函式會設定 DHCP 伺服器上特定選項值的資訊。

語法

DWORD DHCP_API_FUNCTION DhcpSetOptionValue(
  [in] DHCP_CONST WCHAR                  *ServerIpAddress,
  [in] DHCP_OPTION_ID                    OptionID,
  [in] DHCP_CONST DHCP_OPTION_SCOPE_INFO *ScopeInfo,
  [in] DHCP_CONST DHCP_OPTION_DATA       *OptionValue
);

參數

[in] ServerIpAddress

指定 DHCP 伺服器的 IP 位址或主機名的 Unicode 字串指標。

[in] OptionID

DHCP_OPTION_ID 值，指定 DHCP 選項的唯一程序代碼。

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO結構的指標，其中包含描述將設定這個選項值之層級 (默認、伺服器、範圍或 IPv4 保留) 的資訊。

[in] OptionValue

DHCP_OPTION_DATA 結構的指標，其中包含對應至 OptionID 所指定 DHCP 選項程式代碼的數據值。

傳回值

此函式會在成功呼叫時 傳回ERROR_SUCCESS 。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

傳回碼 Description
ERROR_DHCP_JET_ERROR
 存取 DHCP 伺服器資料庫時發生錯誤。
ERROR_DHCP_OPTION_NOT_PRESENT
 在 DHCP 伺服器資料庫中找不到指定的選項定義。
ERROR_DHCP_SUBNET_NOT_PRESENT
 DHCP 伺服器上沒有指定的 IPv4 子網。
ERROR_DHCP_NOT_RESERVED_CLIENT
 指定的 DHCP 用戶端不是保留的用戶端。
ERROR_FILE_NOT_FOUND
 DHCP 伺服器上找不到 ScopeInfo 中指定的多播範圍。

備註

第一次呼叫此函式時，它會在 DHCP 伺服器資料庫中建立提供的選項值。 否則，它會修改與預設使用者類別和廠商類別相關聯之特定選項的選項值。 這些值可以針對 DHCP 伺服器上的預設、伺服器、範圍或 IPv4 保留層級進行設定。

規格需求

需求 值
最低支援的用戶端 都不支援
最低支援的伺服器 Windows Server 2008 R2 [僅限桌面應用程式]
目標平台 Windows
標頭 dhcpsapi.h
程式庫 Dhcpsapi.lib
Dll Dhcpsapi.dll

另請參閱

DHCP_OPTION_DATA

DHCP_OPTION_SCOPE_INFO

DhcpSetOptionValueV5

DhcpSetOptionValues