Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › SetNetworkInformation

SetNetworkInformation

関数
GUIDで指定したネットワークのコンパートメントIDや名前を設定する。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

WIN32_ERROR SetNetworkInformation(
    const GUID* NetworkGuid,
    NET_IF_COMPARTMENT_ID CompartmentId,
    LPCWSTR NetworkName
);

パラメーター

名前方向説明
NetworkGuidGUID*in予約済みです。
CompartmentIdNET_IF_COMPARTMENT_IDin予約済みです。
NetworkNameLPCWSTRin予約済みです。

戻り値の型: WIN32_ERROR

公式ドキュメント

将来の使用のために予約されています。この関数は使用しないでください。(SetNetworkInformation)

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

各言語での呼び出し定義

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

WIN32_ERROR SetNetworkInformation(
    const GUID* NetworkGuid,
    NET_IF_COMPARTMENT_ID CompartmentId,
    LPCWSTR NetworkName
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetNetworkInformation(
    ref Guid NetworkGuid,   // GUID*
    uint CompartmentId,   // NET_IF_COMPARTMENT_ID
    [MarshalAs(UnmanagedType.LPWStr)] string NetworkName   // LPCWSTR
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetNetworkInformation(
    ByRef NetworkGuid As Guid,   ' GUID*
    CompartmentId As UInteger,   ' NET_IF_COMPARTMENT_ID
    <MarshalAs(UnmanagedType.LPWStr)> NetworkName As String   ' LPCWSTR
) As UInteger
End Function
' NetworkGuid : GUID*
' CompartmentId : NET_IF_COMPARTMENT_ID
' NetworkName : LPCWSTR
Declare PtrSafe Function SetNetworkInformation Lib "iphlpapi" ( _
    ByVal NetworkGuid As LongPtr, _
    ByVal CompartmentId As Long, _
    ByVal NetworkName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetNetworkInformation = ctypes.windll.iphlpapi.SetNetworkInformation
SetNetworkInformation.restype = wintypes.DWORD
SetNetworkInformation.argtypes = [
    ctypes.c_void_p,  # NetworkGuid : GUID*
    wintypes.DWORD,  # CompartmentId : NET_IF_COMPARTMENT_ID
    wintypes.LPCWSTR,  # NetworkName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetNetworkInformation = Fiddle::Function.new(
  lib['SetNetworkInformation'],
  [
    Fiddle::TYPE_VOIDP,  # NetworkGuid : GUID*
    -Fiddle::TYPE_INT,  # CompartmentId : NET_IF_COMPARTMENT_ID
    Fiddle::TYPE_VOIDP,  # NetworkName : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn SetNetworkInformation(
        NetworkGuid: *const GUID,  // GUID*
        CompartmentId: u32,  // NET_IF_COMPARTMENT_ID
        NetworkName: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetNetworkInformation(ref Guid NetworkGuid, uint CompartmentId, [MarshalAs(UnmanagedType.LPWStr)] string NetworkName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetNetworkInformation' -Namespace Win32 -PassThru
# $api::SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
#uselib "IPHLPAPI.dll"
#func global SetNetworkInformation "SetNetworkInformation" sptr, sptr, sptr
; SetNetworkInformation varptr(NetworkGuid), CompartmentId, NetworkName   ; 戻り値は stat
; NetworkGuid : GUID* -> "sptr"
; CompartmentId : NET_IF_COMPARTMENT_ID -> "sptr"
; NetworkName : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global SetNetworkInformation "SetNetworkInformation" var, int, wstr
; res = SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
; NetworkGuid : GUID* -> "var"
; CompartmentId : NET_IF_COMPARTMENT_ID -> "int"
; NetworkName : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SetNetworkInformation(GUID* NetworkGuid, NET_IF_COMPARTMENT_ID CompartmentId, LPCWSTR NetworkName)
#uselib "IPHLPAPI.dll"
#cfunc global SetNetworkInformation "SetNetworkInformation" var, int, wstr
; res = SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
; NetworkGuid : GUID* -> "var"
; CompartmentId : NET_IF_COMPARTMENT_ID -> "int"
; NetworkName : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetNetworkInformation = iphlpapi.NewProc("SetNetworkInformation")
)

// NetworkGuid (GUID*), CompartmentId (NET_IF_COMPARTMENT_ID), NetworkName (LPCWSTR)
r1, _, err := procSetNetworkInformation.Call(
	uintptr(NetworkGuid),
	uintptr(CompartmentId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(NetworkName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SetNetworkInformation(
  NetworkGuid: PGUID;   // GUID*
  CompartmentId: DWORD;   // NET_IF_COMPARTMENT_ID
  NetworkName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetNetworkInformation';
result := DllCall("IPHLPAPI\SetNetworkInformation"
    , "Ptr", NetworkGuid   ; GUID*
    , "UInt", CompartmentId   ; NET_IF_COMPARTMENT_ID
    , "WStr", NetworkName   ; LPCWSTR
    , "UInt")   ; return: WIN32_ERROR
●SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName) = DLL("IPHLPAPI.dll", "dword SetNetworkInformation(void*, dword, char*)")
# 呼び出し: SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
# NetworkGuid : GUID* -> "void*"
# CompartmentId : NET_IF_COMPARTMENT_ID -> "dword"
# NetworkName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn SetNetworkInformation(
    NetworkGuid: [*c]GUID, // GUID*
    CompartmentId: u32, // NET_IF_COMPARTMENT_ID
    NetworkName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
proc SetNetworkInformation(
    NetworkGuid: ptr GUID,  # GUID*
    CompartmentId: uint32,  # NET_IF_COMPARTMENT_ID
    NetworkName: WideCString  # LPCWSTR
): uint32 {.importc: "SetNetworkInformation", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint SetNetworkInformation(
    GUID* NetworkGuid,   // GUID*
    uint CompartmentId,   // NET_IF_COMPARTMENT_ID
    const(wchar)* NetworkName   // LPCWSTR
);
ccall((:SetNetworkInformation, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{GUID}, UInt32, Cwstring),
      NetworkGuid, CompartmentId, NetworkName)
# NetworkGuid : GUID* -> Ptr{GUID}
# CompartmentId : NET_IF_COMPARTMENT_ID -> UInt32
# NetworkName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetNetworkInformation(
    void* NetworkGuid,
    uint32_t CompartmentId,
    const uint16_t* NetworkName);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
-- NetworkGuid : GUID*
-- CompartmentId : NET_IF_COMPARTMENT_ID
-- NetworkName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const SetNetworkInformation = lib.func('__stdcall', 'SetNetworkInformation', 'uint32_t', ['void *', 'uint32_t', 'str16']);
// SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
// NetworkGuid : GUID* -> 'void *'
// CompartmentId : NET_IF_COMPARTMENT_ID -> 'uint32_t'
// NetworkName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  SetNetworkInformation: { parameters: ["pointer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName)
// NetworkGuid : GUID* -> "pointer"
// CompartmentId : NET_IF_COMPARTMENT_ID -> "u32"
// NetworkName : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetNetworkInformation(
    void* NetworkGuid,
    uint32_t CompartmentId,
    const uint16_t* NetworkName);
C, "IPHLPAPI.dll");
// $ffi->SetNetworkInformation(NetworkGuid, CompartmentId, NetworkName);
// NetworkGuid : GUID*
// CompartmentId : NET_IF_COMPARTMENT_ID
// NetworkName : LPCWSTR
// 構造体/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 SetNetworkInformation(
        Pointer NetworkGuid,   // GUID*
        int CompartmentId,   // NET_IF_COMPARTMENT_ID
        WString NetworkName   // LPCWSTR
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun SetNetworkInformation = SetNetworkInformation(
    NetworkGuid : GUID*,   # GUID*
    CompartmentId : UInt32,   # NET_IF_COMPARTMENT_ID
    NetworkName : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetNetworkInformationNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf16>);
typedef SetNetworkInformationDart = int Function(Pointer<Void>, int, Pointer<Utf16>);
final SetNetworkInformation = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<SetNetworkInformationNative, SetNetworkInformationDart>('SetNetworkInformation');
// NetworkGuid : GUID* -> Pointer<Void>
// CompartmentId : NET_IF_COMPARTMENT_ID -> Uint32
// NetworkName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetNetworkInformation(
  NetworkGuid: PGUID;   // GUID*
  CompartmentId: DWORD;   // NET_IF_COMPARTMENT_ID
  NetworkName: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetNetworkInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetNetworkInformation"
  c_SetNetworkInformation :: Ptr () -> Word32 -> CWString -> IO Word32
-- NetworkGuid : GUID* -> Ptr ()
-- CompartmentId : NET_IF_COMPARTMENT_ID -> Word32
-- NetworkName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setnetworkinformation =
  foreign "SetNetworkInformation"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* NetworkGuid : GUID* -> (ptr void) *)
(* CompartmentId : NET_IF_COMPARTMENT_ID -> uint32_t *)
(* NetworkName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("SetNetworkInformation" set-network-information :convention :stdcall) :uint32
  (network-guid :pointer)   ; GUID*
  (compartment-id :uint32)   ; NET_IF_COMPARTMENT_ID
  (network-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetNetworkInformation = Win32::API::More->new('IPHLPAPI',
    'DWORD SetNetworkInformation(LPVOID NetworkGuid, DWORD CompartmentId, LPCWSTR NetworkName)');
# my $ret = $SetNetworkInformation->Call($NetworkGuid, $CompartmentId, $NetworkName);
# NetworkGuid : GUID* -> LPVOID
# CompartmentId : NET_IF_COMPARTMENT_ID -> DWORD
# NetworkName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型