DhcpGetAllOptionValues 関数 (dhcpsapi.h)

DhcpGetAllOptionValues 関数は、DHCP サーバー上の特定のスコープに対して定義されているすべてのオプション値を含む配列を返します。

構文

DWORD DhcpGetAllOptionValues(
  [in]  LPWSTR                   ServerIpAddress,
  [in]  DWORD                    Flags,
  [in]  LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out] LPDHCP_ALL_OPTION_VALUES *Values
);

パラメーター

[in] ServerIpAddress

DHCP サーバーの IP アドレスまたはホスト名を指定する Unicode 文字列。

[in] Flags

オプションがベンダー固有かどうかを示すビット フラグを指定します。 仕入先オプションの修飾が必要ない場合、このパラメーターは 0 にする必要があります。

値 意味
DHCP_FLAGS_OPTION_IS_VENDOR
 ベンダー固有のオプションが必要な場合は、このフラグを設定する必要があります。

[in] ScopeInfo

オプション 値が返 される特定のスコープに関する情報を含むDHCP_OPTION_SCOPE_INFO構造体へのポインター。 この情報は、デフォルト、サーバー、またはスコープ・レベル、または特定の IPv4 予約から取得されるオプション値を定義します。

[out] Values

ScopeInfoで指定されたスコープに対して返されるオプション値を含むDHCP_ALL_OPTION_VALUES構造体へのポインター。

注  

このパラメーターのメモリは、 DhcpRpcFreeMemory を使用して解放する必要があります。

 

戻り値

この関数は、呼び出しが成功すると ERROR_SUCCESS を返します。 それ以外の場合は、 DHCP サーバー管理 API エラー コードのいずれかを返します。

リターン コード 説明
ERROR_ACCESS_DENIED
 この呼び出しは、"DHCP 管理者" セキュリティ グループのメンバーではないクライアントによって実行されました。
ERROR_DHCP_SUBNET_NOT_PRESENT
 この指定された IPv4 サンセットは、DHCP サーバーでは定義されていません。
ERROR_DHCP_NOT_RESERVED_CLIENT
 指定された DHCP クライアントは予約済みクライアントではありません。

注釈

DHCP サーバーで定義されている各ベンダー/クラス ペアの Values で指定された配列には、1 つのオプション値があります。

要件

要件 値
サポートされている最小のクライアント サポートなし
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー dhcpsapi.h
Library Dhcpsapi.lib
[DLL] Dhcpsapi.dll

こちらもご覧ください

DhcpGetAllOptions

  • Last updated on