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

GetNetworkParams

関数
ホスト名やDNSサーバーなどのネットワーク構成情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR GetNetworkParams(
    FIXED_INFO_W2KSP1* pFixedInfo,   // optional
    DWORD* pOutBufLen
);

パラメーター

名前方向説明
pFixedInfoFIXED_INFO_W2KSP1*outoptional関数が成功した場合に、ローカルコンピューターのネットワークパラメーターを受け取る FIXED_INFO 構造体を格納するバッファーへのポインター。このバッファーは、GetNetworkParams 関数を呼び出す前に呼び出し元が割り当てておく必要があります。
pOutBufLenDWORD*inoutFIXED_INFO 構造体のサイズを指定する ULONG 変数へのポインター。このサイズが情報を格納するのに不十分な場合、GetNetworkParams はこの変数に必要なサイズを書き込み、エラーコード ERROR_BUFFER_OVERFLOW を返します。

戻り値の型: WIN32_ERROR

公式ドキュメント

GetNetworkParams 関数は、ローカルコンピューターのネットワークパラメーターを取得します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値 説明
ERROR_BUFFER_OVERFLOW
ネットワークパラメーター情報を受け取るバッファーが小さすぎます。この値は、pOutBufLen パラメーターがネットワークパラメーター情報を格納するには小さすぎる場合、または pFixedInfo パラメーターが NULL ポインターであった場合に返されます。このエラーコードが返されたとき、pOutBufLen パラメーターは必要なバッファーサイズを指します。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、pOutBufLen パラメーターが NULL ポインターである場合、呼び出し元プロセスが pOutBufLen が指すメモリへの読み取り/書き込みアクセス権を持たない場合、または呼び出し元プロセスが pFixedInfo パラメーターが指すメモリへの書き込みアクセス権を持たない場合に返されます。
ERROR_NO_DATA
ローカルコンピューターにネットワークパラメーター情報が存在しません。
ERROR_NOT_SUPPORTED
GetNetworkParams 関数は、ローカルコンピューターで動作しているオペレーティングシステムではサポートされていません。
その他
関数が失敗した場合は、FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

GetNetworkParams 関数は、ローカルコンピューターのネットワークパラメーターを取得するために使用されます。ネットワークパラメーターは FIXED_INFO 構造体で返されます。FIXED_INFO 構造体のためのメモリは、アプリケーションが割り当てる必要があります。このメモリが不要になった際に解放するのはアプリケーションの責任です。

Microsoft Windows Software Development Kit (SDK) では、FIXED_INFO_WIN2KSP1 構造体が定義されています。アプリケーションをコンパイルする際、ターゲットプラットフォームが Windows 2000 with Service Pack 1 (SP1) 以降である場合(NTDDI_VERSION >= NTDDI_WIN2KSP1_WIN32_WINNT >= 0x0501、または WINVER >= 0x0501)、FIXED_INFO_WIN2KSP1 構造体は FIXED_INFO 構造体に typedef されます。ターゲットプラットフォームが Windows 2000 with SP1 以降でない場合にアプリケーションをコンパイルすると、FIXED_INFO 構造体は未定義になります。

GetNetworkParams 関数および FIXED_INFO 構造体は、Windows 98 以降でサポートされています。ただし、Windows 2000 with Service Pack 1 (SP1) より前のターゲットプラットフォーム向けにアプリケーションをビルドするには、以前のバージョンの Platform Software Development Kit (SDK) を使用する必要があります。

次の例は、ローカルコンピューターのネットワークパラメーターを取得し、返されたデータから情報を出力します。

//
// Link with IPHlpAPI.lib
//
#include <winsock2.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <windows.h>
#pragma comment(lib, "IPHLPAPI.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int __cdecl main()
{

    FIXED_INFO *pFixedInfo;
    ULONG ulOutBufLen;
    DWORD dwRetVal;
    IP_ADDR_STRING *pIPAddr;

    pFixedInfo = (FIXED_INFO *) MALLOC(sizeof (FIXED_INFO));
    if (pFixedInfo == NULL) {
        printf("Error allocating memory needed to call GetNetworkParams\n");
        return 1;
    }
    ulOutBufLen = sizeof (FIXED_INFO);

// Make an initial call to GetAdaptersInfo to get
// the necessary size into the ulOutBufLen variable
    if (GetNetworkParams(pFixedInfo, &ulOutBufLen) == ERROR_BUFFER_OVERFLOW) {
        FREE(pFixedInfo);
        pFixedInfo = (FIXED_INFO *) MALLOC(ulOutBufLen);
        if (pFixedInfo == NULL) {
            printf("Error allocating memory needed to call GetNetworkParams\n");
            return 1;
        }
    }

    if (dwRetVal = GetNetworkParams(pFixedInfo, &ulOutBufLen) == NO_ERROR) {

        printf("Host Name: %s\n", pFixedInfo->HostName);
        printf("Domain Name: %s\n", pFixedInfo->DomainName);

        printf("DNS Servers:\n");
        printf("\t%s\n", pFixedInfo->DnsServerList.IpAddress.String);

        pIPAddr = pFixedInfo->DnsServerList.Next;
        while (pIPAddr) {
            printf("\t%s\n", pIPAddr->IpAddress.String);
            pIPAddr = pIPAddr->Next;
        }

        printf("Node Type: ");
        switch (pFixedInfo->NodeType) {
        case BROADCAST_NODETYPE:
            printf("Broadcast node\n");
            break;
        case PEER_TO_PEER_NODETYPE:
            printf("Peer to Peer node\n");
            break;
        case MIXED_NODETYPE:
            printf("Mixed node\n");
            break;
        case HYBRID_NODETYPE:
            printf("Hybrid node\n");
            break;
        default:
            printf("Unknown node type %0lx\n", pFixedInfo->NodeType);
            break;
        }

        printf("DHCP scope name: %s\n", pFixedInfo->ScopeId);

        if (pFixedInfo->EnableRouting)
            printf("Routing: enabled\n");
        else
            printf("Routing: disabled\n");

        if (pFixedInfo->EnableProxy)
            printf("ARP proxy: enabled\n");
        else
            printf("ARP Proxy: disabled\n");

        if (pFixedInfo->EnableDns)
            printf("DNS: enabled\n");
        else
            printf("DNS: disabled\n");

    } else {
        printf("GetNetworkParams failed with error: %d\n", dwRetVal);
        return 1;
    }

    if (pFixedInfo)
        FREE(pFixedInfo);

    return 0;
}

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetNetworkParams(
    FIXED_INFO_W2KSP1* pFixedInfo,   // optional
    DWORD* pOutBufLen
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetNetworkParams(
    IntPtr pFixedInfo,   // FIXED_INFO_W2KSP1* optional, out
    ref uint pOutBufLen   // DWORD* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetNetworkParams(
    pFixedInfo As IntPtr,   ' FIXED_INFO_W2KSP1* optional, out
    ByRef pOutBufLen As UInteger   ' DWORD* in/out
) As UInteger
End Function
' pFixedInfo : FIXED_INFO_W2KSP1* optional, out
' pOutBufLen : DWORD* in/out
Declare PtrSafe Function GetNetworkParams Lib "iphlpapi" ( _
    ByVal pFixedInfo As LongPtr, _
    ByRef pOutBufLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNetworkParams = ctypes.windll.iphlpapi.GetNetworkParams
GetNetworkParams.restype = wintypes.DWORD
GetNetworkParams.argtypes = [
    ctypes.c_void_p,  # pFixedInfo : FIXED_INFO_W2KSP1* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pOutBufLen : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetNetworkParams = iphlpapi.NewProc("GetNetworkParams")
)

// pFixedInfo (FIXED_INFO_W2KSP1* optional, out), pOutBufLen (DWORD* in/out)
r1, _, err := procGetNetworkParams.Call(
	uintptr(pFixedInfo),
	uintptr(pOutBufLen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetNetworkParams(
  pFixedInfo: Pointer;   // FIXED_INFO_W2KSP1* optional, out
  pOutBufLen: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetNetworkParams';
result := DllCall("IPHLPAPI\GetNetworkParams"
    , "Ptr", pFixedInfo   ; FIXED_INFO_W2KSP1* optional, out
    , "Ptr", pOutBufLen   ; DWORD* in/out
    , "UInt")   ; return: WIN32_ERROR
●GetNetworkParams(pFixedInfo, pOutBufLen) = DLL("IPHLPAPI.dll", "dword GetNetworkParams(void*, void*)")
# 呼び出し: GetNetworkParams(pFixedInfo, pOutBufLen)
# pFixedInfo : FIXED_INFO_W2KSP1* optional, out -> "void*"
# pOutBufLen : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetNetworkParamsNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetNetworkParamsDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetNetworkParams = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetNetworkParamsNative, GetNetworkParamsDart>('GetNetworkParams');
// pFixedInfo : FIXED_INFO_W2KSP1* optional, out -> Pointer<Void>
// pOutBufLen : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNetworkParams(
  pFixedInfo: Pointer;   // FIXED_INFO_W2KSP1* optional, out
  pOutBufLen: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetNetworkParams';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNetworkParams"
  c_GetNetworkParams :: Ptr () -> Ptr Word32 -> IO Word32
-- pFixedInfo : FIXED_INFO_W2KSP1* optional, out -> Ptr ()
-- pOutBufLen : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnetworkparams =
  foreign "GetNetworkParams"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* pFixedInfo : FIXED_INFO_W2KSP1* optional, out -> (ptr void) *)
(* pOutBufLen : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetNetworkParams" get-network-params :convention :stdcall) :uint32
  (p-fixed-info :pointer)   ; FIXED_INFO_W2KSP1* optional, out
  (p-out-buf-len :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNetworkParams = Win32::API::More->new('IPHLPAPI',
    'DWORD GetNetworkParams(LPVOID pFixedInfo, LPVOID pOutBufLen)');
# my $ret = $GetNetworkParams->Call($pFixedInfo, $pOutBufLen);
# pFixedInfo : FIXED_INFO_W2KSP1* optional, out -> LPVOID
# pOutBufLen : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型