DhcpV4SetOptionValue 函式 (dhcpsapi.h)

  • 發行項

DhcpV4SetOptionValue函式會設定 DHCP 伺服器上特定選項值的資訊。 此函式允許呼叫端指定選項的原則，藉此擴充 DhcpSetOptionValueV5 所提供的功能。

語法

DWORD DHCP_API_FUNCTION DhcpV4SetOptionValue(
  [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]           LPDHCP_OPTION_DATA       OptionValue
);

參數

[in, optional] ServerIpAddress

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

[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結構的指標，其中包含要設定之選項值範圍的資訊。

[in] OptionValue

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

傳回值

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

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

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

需求

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

另請參閱

DhcpV4GetAllOptionValues

DhcpV4GetOptionValue

DhcpV4RemoveOptionValue

DhcpV4SetOptionValues