CreateAnycastIpAddressEntry
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR CreateAnycastIpAddressEntry(
const MIB_ANYCASTIPADDRESS_ROW* Row
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Row | MIB_ANYCASTIPADDRESS_ROW* | in | エニーキャスト IP アドレスエントリを表す MIB_ANYCASTIPADDRESS_ROW 構造体エントリへのポインター。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ローカルコンピューターに新しいエニーキャスト IP アドレスエントリを追加します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードです。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは、次のような複数の条件で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)による拡張シェルで実行されていない場合などです。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーが有効なユニキャスト IPv4 または IPv6 アドレスに設定されていなかった場合、または Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の InterfaceLuid と InterfaceIndex の両方のメンバーが未指定だった場合に返されます。 | |
| 指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。 | |
| 要求がサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しないにもかかわらず、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーで IPv4 アドレスが指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在しないにもかかわらず、Address メンバーで IPv6 アドレスが指定された場合にも返されます。 | |
| オブジェクトは既に存在します。このエラーは、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーが、MIB_ANYCASTIPADDRESS_ROW の InterfaceLuid または InterfaceIndex メンバーで指定されたインターフェイス上の既存のエニーキャスト IP アドレスと重複している場合に返されます。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用します。 |
解説(Remarks)
CreateAnycastIpAddressEntry 関数は Windows Vista 以降で定義されています。
CreateAnycastIpAddressEntry 関数は、ローカルコンピューターに新しいエニーキャスト IP アドレスエントリを追加するために使用されます。
Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW 構造体の Address メンバーは、有効なユニキャスト IPv4 または IPv6 アドレスおよびアドレスファミリで初期化されている必要があります。さらに、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW 構造体の次のメンバーのうち少なくとも 1 つをインターフェイスで初期化する必要があります。InterfaceLuid または InterfaceIndex です。
これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合、このメンバーを使用してユニキャスト IP アドレスを追加するインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。
Row が指す MIB_ANYCASTIPADDRESS_ROW 構造体の ScopeId メンバーは、CreateAnycastIpAddressEntry 関数が呼び出されたときには無視されます。ScopeId メンバーは、アドレスが追加されるインターフェイスによって自動的に決定されます。
Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーで渡されたエニーキャスト IP アドレスが、インターフェイス上の既存のエニーキャスト IP アドレスと重複している場合、CreateAnycastIpAddressEntry 関数は失敗します。
CreateAnycastIpAddressEntry 関数は、Administrators グループのメンバーとしてログオンしたユーザーのみが呼び出せます。Administrators グループのメンバーではないユーザーが CreateAnycastIpAddressEntry を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザーアカウント制御(UAC)が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーによって実行された場合、アプリケーションのマニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーがこの関数を成功させるには、組み込みの Administrator(管理者として実行)による拡張シェルでアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR CreateAnycastIpAddressEntry(
const MIB_ANYCASTIPADDRESS_ROW* Row
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint CreateAnycastIpAddressEntry(
IntPtr Row // MIB_ANYCASTIPADDRESS_ROW*
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function CreateAnycastIpAddressEntry(
Row As IntPtr ' MIB_ANYCASTIPADDRESS_ROW*
) As UInteger
End Function' Row : MIB_ANYCASTIPADDRESS_ROW*
Declare PtrSafe Function CreateAnycastIpAddressEntry Lib "iphlpapi" ( _
ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CreateAnycastIpAddressEntry = ctypes.windll.iphlpapi.CreateAnycastIpAddressEntry
CreateAnycastIpAddressEntry.restype = wintypes.DWORD
CreateAnycastIpAddressEntry.argtypes = [
ctypes.c_void_p, # Row : MIB_ANYCASTIPADDRESS_ROW*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
CreateAnycastIpAddressEntry = Fiddle::Function.new(
lib['CreateAnycastIpAddressEntry'],
[
Fiddle::TYPE_VOIDP, # Row : MIB_ANYCASTIPADDRESS_ROW*
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn CreateAnycastIpAddressEntry(
Row: *const MIB_ANYCASTIPADDRESS_ROW // MIB_ANYCASTIPADDRESS_ROW*
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint CreateAnycastIpAddressEntry(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_CreateAnycastIpAddressEntry' -Namespace Win32 -PassThru
# $api::CreateAnycastIpAddressEntry(Row)#uselib "IPHLPAPI.dll"
#func global CreateAnycastIpAddressEntry "CreateAnycastIpAddressEntry" sptr
; CreateAnycastIpAddressEntry varptr(Row) ; 戻り値は stat
; Row : MIB_ANYCASTIPADDRESS_ROW* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global CreateAnycastIpAddressEntry "CreateAnycastIpAddressEntry" var ; res = CreateAnycastIpAddressEntry(Row) ; Row : MIB_ANYCASTIPADDRESS_ROW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global CreateAnycastIpAddressEntry "CreateAnycastIpAddressEntry" sptr ; res = CreateAnycastIpAddressEntry(varptr(Row)) ; Row : MIB_ANYCASTIPADDRESS_ROW* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; WIN32_ERROR CreateAnycastIpAddressEntry(MIB_ANYCASTIPADDRESS_ROW* Row) #uselib "IPHLPAPI.dll" #cfunc global CreateAnycastIpAddressEntry "CreateAnycastIpAddressEntry" var ; res = CreateAnycastIpAddressEntry(Row) ; Row : MIB_ANYCASTIPADDRESS_ROW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR CreateAnycastIpAddressEntry(MIB_ANYCASTIPADDRESS_ROW* Row) #uselib "IPHLPAPI.dll" #cfunc global CreateAnycastIpAddressEntry "CreateAnycastIpAddressEntry" intptr ; res = CreateAnycastIpAddressEntry(varptr(Row)) ; Row : MIB_ANYCASTIPADDRESS_ROW* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procCreateAnycastIpAddressEntry = iphlpapi.NewProc("CreateAnycastIpAddressEntry")
)
// Row (MIB_ANYCASTIPADDRESS_ROW*)
r1, _, err := procCreateAnycastIpAddressEntry.Call(
uintptr(Row),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction CreateAnycastIpAddressEntry(
Row: Pointer // MIB_ANYCASTIPADDRESS_ROW*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateAnycastIpAddressEntry';result := DllCall("IPHLPAPI\CreateAnycastIpAddressEntry"
, "Ptr", Row ; MIB_ANYCASTIPADDRESS_ROW*
, "UInt") ; return: WIN32_ERROR●CreateAnycastIpAddressEntry(Row) = DLL("IPHLPAPI.dll", "dword CreateAnycastIpAddressEntry(void*)")
# 呼び出し: CreateAnycastIpAddressEntry(Row)
# Row : MIB_ANYCASTIPADDRESS_ROW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn CreateAnycastIpAddressEntry(
Row: [*c]MIB_ANYCASTIPADDRESS_ROW // MIB_ANYCASTIPADDRESS_ROW*
) callconv(std.os.windows.WINAPI) u32;proc CreateAnycastIpAddressEntry(
Row: ptr MIB_ANYCASTIPADDRESS_ROW # MIB_ANYCASTIPADDRESS_ROW*
): uint32 {.importc: "CreateAnycastIpAddressEntry", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint CreateAnycastIpAddressEntry(
MIB_ANYCASTIPADDRESS_ROW* Row // MIB_ANYCASTIPADDRESS_ROW*
);ccall((:CreateAnycastIpAddressEntry, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_ANYCASTIPADDRESS_ROW},),
Row)
# Row : MIB_ANYCASTIPADDRESS_ROW* -> Ptr{MIB_ANYCASTIPADDRESS_ROW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t CreateAnycastIpAddressEntry(
void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.CreateAnycastIpAddressEntry(Row)
-- Row : MIB_ANYCASTIPADDRESS_ROW*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const CreateAnycastIpAddressEntry = lib.func('__stdcall', 'CreateAnycastIpAddressEntry', 'uint32_t', ['void *']);
// CreateAnycastIpAddressEntry(Row)
// Row : MIB_ANYCASTIPADDRESS_ROW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
CreateAnycastIpAddressEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.CreateAnycastIpAddressEntry(Row)
// Row : MIB_ANYCASTIPADDRESS_ROW* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t CreateAnycastIpAddressEntry(
void* Row);
C, "IPHLPAPI.dll");
// $ffi->CreateAnycastIpAddressEntry(Row);
// Row : MIB_ANYCASTIPADDRESS_ROW*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int CreateAnycastIpAddressEntry(
Pointer Row // MIB_ANYCASTIPADDRESS_ROW*
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun CreateAnycastIpAddressEntry = CreateAnycastIpAddressEntry(
Row : MIB_ANYCASTIPADDRESS_ROW* # MIB_ANYCASTIPADDRESS_ROW*
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CreateAnycastIpAddressEntryNative = Uint32 Function(Pointer<Void>);
typedef CreateAnycastIpAddressEntryDart = int Function(Pointer<Void>);
final CreateAnycastIpAddressEntry = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<CreateAnycastIpAddressEntryNative, CreateAnycastIpAddressEntryDart>('CreateAnycastIpAddressEntry');
// Row : MIB_ANYCASTIPADDRESS_ROW* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CreateAnycastIpAddressEntry(
Row: Pointer // MIB_ANYCASTIPADDRESS_ROW*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateAnycastIpAddressEntry';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CreateAnycastIpAddressEntry"
c_CreateAnycastIpAddressEntry :: Ptr () -> IO Word32
-- Row : MIB_ANYCASTIPADDRESS_ROW* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let createanycastipaddressentry =
foreign "CreateAnycastIpAddressEntry"
((ptr void) @-> returning uint32_t)
(* Row : MIB_ANYCASTIPADDRESS_ROW* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("CreateAnycastIpAddressEntry" create-anycast-ip-address-entry :convention :stdcall) :uint32
(row :pointer)) ; MIB_ANYCASTIPADDRESS_ROW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CreateAnycastIpAddressEntry = Win32::API::More->new('IPHLPAPI',
'DWORD CreateAnycastIpAddressEntry(LPVOID Row)');
# my $ret = $CreateAnycastIpAddressEntry->Call($Row);
# Row : MIB_ANYCASTIPADDRESS_ROW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f DeleteAnycastIpAddressEntry — 指定したエニーキャストIPアドレスエントリを削除する。
- f GetAnycastIpAddressEntry — 指定したエニーキャストIPアドレスの情報を取得する。
- f GetAnycastIpAddressTable — エニーキャストIPアドレスの一覧テーブルを取得する。
- s MIB_ANYCASTIPADDRESS_TABLE