ホーム › NetworkManagement.IpHelper › GetNetworkInformation

GetNetworkInformation

関数

GUIDで指定したネットワークのコンパートメントやサイトIDなどの情報を取得する。

DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

WIN32_ERROR GetNetworkInformation(
    const GUID* NetworkGuid,
    DWORD* CompartmentId,
    DWORD* SiteId,
    LPWSTR NetworkName,
    DWORD Length
);

パラメーター

名前	型	方向	説明
NetworkGuid	GUID*	in	予約済みです。
CompartmentId	DWORD*	out	予約済みです。
SiteId	DWORD*	out	予約済みです。
NetworkName	LPWSTR	out	予約済みです。
Length	DWORD	in	予約済みです。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetNetworkInformation(
    const GUID* NetworkGuid,
    DWORD* CompartmentId,
    DWORD* SiteId,
    LPWSTR NetworkName,
    DWORD Length
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetNetworkInformation(
    ref Guid NetworkGuid,   // GUID*
    out uint CompartmentId,   // DWORD* out
    out uint SiteId,   // DWORD* out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder NetworkName,   // LPWSTR out
    uint Length   // DWORD
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetNetworkInformation(
    ByRef NetworkGuid As Guid,   ' GUID*
    <Out> ByRef CompartmentId As UInteger,   ' DWORD* out
    <Out> ByRef SiteId As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPWStr)> NetworkName As System.Text.StringBuilder,   ' LPWSTR out
    Length As UInteger   ' DWORD
) As UInteger
End Function

' NetworkGuid : GUID*
' CompartmentId : DWORD* out
' SiteId : DWORD* out
' NetworkName : LPWSTR out
' Length : DWORD
Declare PtrSafe Function GetNetworkInformation Lib "iphlpapi" ( _
    ByVal NetworkGuid As LongPtr, _
    ByRef CompartmentId As Long, _
    ByRef SiteId As Long, _
    ByVal NetworkName As LongPtr, _
    ByVal Length As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNetworkInformation = ctypes.windll.iphlpapi.GetNetworkInformation
GetNetworkInformation.restype = wintypes.DWORD
GetNetworkInformation.argtypes = [
    ctypes.c_void_p,  # NetworkGuid : GUID*
    ctypes.POINTER(wintypes.DWORD),  # CompartmentId : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # SiteId : DWORD* out
    wintypes.LPWSTR,  # NetworkName : LPWSTR out
    wintypes.DWORD,  # Length : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetNetworkInformation = Fiddle::Function.new(
  lib['GetNetworkInformation'],
  [
    Fiddle::TYPE_VOIDP,  # NetworkGuid : GUID*
    Fiddle::TYPE_VOIDP,  # CompartmentId : DWORD* out
    Fiddle::TYPE_VOIDP,  # SiteId : DWORD* out
    Fiddle::TYPE_VOIDP,  # NetworkName : LPWSTR out
    -Fiddle::TYPE_INT,  # Length : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetNetworkInformation(
        NetworkGuid: *const GUID,  // GUID*
        CompartmentId: *mut u32,  // DWORD* out
        SiteId: *mut u32,  // DWORD* out
        NetworkName: *mut u16,  // LPWSTR out
        Length: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetNetworkInformation(ref Guid NetworkGuid, out uint CompartmentId, out uint SiteId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder NetworkName, uint Length);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetNetworkInformation' -Namespace Win32 -PassThru
# $api::GetNetworkInformation(NetworkGuid, CompartmentId, SiteId, NetworkName, Length)

#uselib "IPHLPAPI.dll"
#func global GetNetworkInformation "GetNetworkInformation" sptr, sptr, sptr, sptr, sptr
; GetNetworkInformation varptr(NetworkGuid), varptr(CompartmentId), varptr(SiteId), varptr(NetworkName), Length   ; 戻り値は stat
; NetworkGuid : GUID* -> "sptr"
; CompartmentId : DWORD* out -> "sptr"
; SiteId : DWORD* out -> "sptr"
; NetworkName : LPWSTR out -> "sptr"
; Length : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetNetworkInformation "GetNetworkInformation" var, var, var, var, int
; res = GetNetworkInformation(NetworkGuid, CompartmentId, SiteId, NetworkName, Length)
; NetworkGuid : GUID* -> "var"
; CompartmentId : DWORD* out -> "var"
; SiteId : DWORD* out -> "var"
; NetworkName : LPWSTR out -> "var"
; Length : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetNetworkInformation "GetNetworkInformation" sptr, sptr, sptr, sptr, int
; res = GetNetworkInformation(varptr(NetworkGuid), varptr(CompartmentId), varptr(SiteId), varptr(NetworkName), Length)
; NetworkGuid : GUID* -> "sptr"
; CompartmentId : DWORD* out -> "sptr"
; SiteId : DWORD* out -> "sptr"
; NetworkName : LPWSTR out -> "sptr"
; Length : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。