ホーム › NetworkManagement.Dhcp › DhcpV4FailoverSetRelationship

DhcpV4FailoverSetRelationship

関数

既存のIPv4フェールオーバー関係のパラメーターを設定する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpV4FailoverSetRelationship(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DHCP_FAILOVER_RELATIONSHIP* pRelationship
);

パラメーター

名前

型

方向

説明

ServerIpAddress

LPWSTR

inoptional

DHCP サーバーの IP アドレスまたはホスト名を表す、null で終わる Unicode 文字列へのポインター。

Flags

DWORD

pRelationship 内で更新するフィールドを指定するビットマスク。各値は、変更対象となる DHCP_FAILOVER_RELATIONSHIP 構造体のメンバーを指定します。

フラグ	意味
MCLT 0x00000001	pRelationship パラメーター構造体の mclt メンバーが設定されます。
SAFEPERIOD 0x00000002	pRelationship パラメーター構造体の safePeriod メンバーが設定されます。
CHANGESTATE 0x00000004	pRelationship パラメーター構造体の state メンバーが設定されます。
PERCENTAGE 0x00000008	pRelationship パラメーター構造体の percentage メンバーが設定されます。
MODE 0x00000010	pRelationship パラメーター構造体の mode メンバーが設定されます。
PREVSTATE 0x00000020	pRelationship パラメーター構造体の prevState メンバーが設定されます。

pRelationship

DHCP_FAILOVER_RELATIONSHIP*

DHCPv4 フェールオーバー関係のフィールドに関する更新情報を格納する DHCP_FAILOVER_RELATIONSHIP 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

DHCPv4 サーバーのフェールオーバー関係のパラメーターを設定または変更します。

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合は、次のいずれかの値、または DHCP Server Management API Error Codes のエラーコードを返します。

値	意味
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効でした。
ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST	フェールオーバー関係が存在しません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpV4FailoverSetRelationship(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DHCP_FAILOVER_RELATIONSHIP* pRelationship
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4FailoverSetRelationship(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint Flags,   // DWORD
    IntPtr pRelationship   // DHCP_FAILOVER_RELATIONSHIP*
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4FailoverSetRelationship(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    Flags As UInteger,   ' DWORD
    pRelationship As IntPtr   ' DHCP_FAILOVER_RELATIONSHIP*
) As UInteger
End Function

' ServerIpAddress : LPWSTR optional
' Flags : DWORD
' pRelationship : DHCP_FAILOVER_RELATIONSHIP*
Declare PtrSafe Function DhcpV4FailoverSetRelationship Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal Flags As Long, _
    ByVal pRelationship As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpV4FailoverSetRelationship = ctypes.windll.dhcpsapi.DhcpV4FailoverSetRelationship
DhcpV4FailoverSetRelationship.restype = wintypes.DWORD
DhcpV4FailoverSetRelationship.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # pRelationship : DHCP_FAILOVER_RELATIONSHIP*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4FailoverSetRelationship = Fiddle::Function.new(
  lib['DhcpV4FailoverSetRelationship'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # pRelationship : DHCP_FAILOVER_RELATIONSHIP*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4FailoverSetRelationship(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        Flags: u32,  // DWORD
        pRelationship: *mut DHCP_FAILOVER_RELATIONSHIP  // DHCP_FAILOVER_RELATIONSHIP*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4FailoverSetRelationship([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint Flags, IntPtr pRelationship);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4FailoverSetRelationship' -Namespace Win32 -PassThru
# $api::DhcpV4FailoverSetRelationship(ServerIpAddress, Flags, pRelationship)

#uselib "DHCPSAPI.dll"
#func global DhcpV4FailoverSetRelationship "DhcpV4FailoverSetRelationship" sptr, sptr, sptr
; DhcpV4FailoverSetRelationship ServerIpAddress, Flags, varptr(pRelationship)   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; pRelationship : DHCP_FAILOVER_RELATIONSHIP* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4FailoverSetRelationship "DhcpV4FailoverSetRelationship" wstr, int, var
; res = DhcpV4FailoverSetRelationship(ServerIpAddress, Flags, pRelationship)
; ServerIpAddress : LPWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; pRelationship : DHCP_FAILOVER_RELATIONSHIP* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4FailoverSetRelationship "DhcpV4FailoverSetRelationship" wstr, int, sptr
; res = DhcpV4FailoverSetRelationship(ServerIpAddress, Flags, varptr(pRelationship))
; ServerIpAddress : LPWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; pRelationship : DHCP_FAILOVER_RELATIONSHIP* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。