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

MultinetGetConnectionPerformanceW

関数
ネットワーク接続の性能情報を取得する(Unicode版)。
DLLMPR.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// MPR.dll  (Unicode / -W)
#include <windows.h>

DWORD MultinetGetConnectionPerformanceW(
    NETRESOURCEW* lpNetResource,
    NETCONNECTINFOSTRUCT* lpNetConnectInfoStruct
);

パラメーター

名前型方向説明
lpNetResourceNETRESOURCEW*in

ネットワークリソースを指定する NETRESOURCE 構造体へのポインター。このコンテキストでは、次のメンバーが特別な意味を持ちます。

メンバー 意味
lpLocalName
照会するネットワークリソースにリダイレクトされているローカルデバイス ("F:" や "LPT1" など) を指定するバッファーへのポインター。

このメンバーが NULL または空の文字列である場合、ネットワークリソースは lpRemoteName メンバーで指定します。このフラグがローカルデバイスを指定している場合、lpRemoteName は無視されます。

lpRemoteName
照会するネットワークリソースへのポインター。そのリソースには、現在確立された接続が存在している必要があります。たとえば、リソースがファイルサーバー上のファイルである場合、そのファイルを開いておくことで接続が確保されます。
lpProvider
通常は NULL を設定しますが、リソースが存在するネットワークが判明している場合は、そのリソースの所有者 (プロバイダー) へのポインターを指定できます。

lpProvider メンバーが NULL でない場合、システムは指定された名前のネットワークに関する情報のみを返そうとします。

lpNetConnectInfoStructNETCONNECTINFOSTRUCT*outデータを受け取る NETCONNECTINFOSTRUCT 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

ネットワークリソースへのアクセスに使用される接続の予測パフォーマンスに関する情報を返します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は システムエラーコード であり、次のいずれかの値になることがあります。

リターンコード 説明
ERROR_NOT_SUPPORTED
そのネットワークリソースは、この情報を提供しません。
ERROR_NOT_CONNECTED
lpNetResource パラメーターが指す NETRESOURCE 構造体の lpLocalName メンバーがリダイレクトされたデバイスを指定していないか、lpRemoteName メンバーが現在接続されているリソースの名前を指定していません。
ERROR_NO_NET_OR_BAD_PATH
ネットワークコンポーネントが開始されていないか、指定されたリソース名が認識されないため、操作を完了できませんでした。
ERROR_BAD_DEVICE
lpLocalName メンバーで指定されたローカルデバイスが無効です。
ERROR_BAD_NET_NAME
ネットワーク名が見つかりません。このエラーは、lpNetResource パラメーターが指す NETRESOURCE 構造体の lpLocalName メンバーが NULL で、かつ lpNetResource が指す NETRESOURCE 構造体の lpRemoteName メンバーも NULL であるか、どのネットワークでも認識できなかった場合に返されます。
ERROR_INVALID_ADDRESS
無効なアドレスへのアクセスが試行されました。このエラーは、lpNetResource パラメーターまたは lpNetConnectInfoStruct パラメーターが NULL であった場合に返されます。
ERROR_INVALID_PARAMETER
不正なパラメーターが渡されました。このエラーは、lpNetConnectInfoStruct パラメーターが、cbStructure メンバーに適切な構造体サイズが設定された NETCONNECTINFOSTRUCT 構造体を指していない場合に返されます。
ERROR_NO_NETWORK
ネットワークが利用できません。
ERROR_EXTENDED_ERROR
ネットワーク固有のエラーが発生しました。エラーの説明を取得するには、 WNetGetLastError を呼び出します。

解説(Remarks)

MultinetGetConnectionPerformance 関数は、情報を NETCONNECTINFOSTRUCT 構造体で返します。

MultinetGetConnectionPerformance 関数が返す情報は、あくまで推定値です。ネットワークトラフィックやルーティングによって、返される結果の正確さが左右されることがあります。

MultinetGetConnectionPerformance 関数は、ネットワークリソースにリダイレクトされているローカルデバイス、または現在接続が確立されているネットワークリソースについてのみ情報を要求できる点に注意してください。

lpNetResource パラメーターが指す NETRESOURCE 構造体の lpRemoteName メンバーに UNC パスを指定する場合、lpRemoteName メンバーはファイル名ではなくディレクトリ名でなければなりません。

この関数の一般的な使い方は、ネットワークサーバー上のファイルを開き (これによりファイルへの接続が確保されます)、この関数を呼び出して、その結果をファイル I/O の管理方法の判断に利用するというものです。たとえば、ファイル全体をクライアント上の一時ファイルに読み込むか、サーバー上のファイルに直接アクセスするかを決定できます。

メモ

winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MultinetGetConnectionPerformance を定義します。エンコードに依存しないエイリアスの使用と、エンコードに依存するコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「関数プロトタイプの表記規則」を参照してください。

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

各言語での呼び出し定義

// MPR.dll  (Unicode / -W)
#include <windows.h>

DWORD MultinetGetConnectionPerformanceW(
    NETRESOURCEW* lpNetResource,
    NETCONNECTINFOSTRUCT* lpNetConnectInfoStruct
);
[DllImport("MPR.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MultinetGetConnectionPerformanceW(
    IntPtr lpNetResource,   // NETRESOURCEW*
    IntPtr lpNetConnectInfoStruct   // NETCONNECTINFOSTRUCT* out
);
<DllImport("MPR.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MultinetGetConnectionPerformanceW(
    lpNetResource As IntPtr,   ' NETRESOURCEW*
    lpNetConnectInfoStruct As IntPtr   ' NETCONNECTINFOSTRUCT* out
) As UInteger
End Function
' lpNetResource : NETRESOURCEW*
' lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out
Declare PtrSafe Function MultinetGetConnectionPerformanceW Lib "mpr" ( _
    ByVal lpNetResource As LongPtr, _
    ByVal lpNetConnectInfoStruct As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MultinetGetConnectionPerformanceW = ctypes.windll.mpr.MultinetGetConnectionPerformanceW
MultinetGetConnectionPerformanceW.restype = wintypes.DWORD
MultinetGetConnectionPerformanceW.argtypes = [
    ctypes.c_void_p,  # lpNetResource : NETRESOURCEW*
    ctypes.c_void_p,  # lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPR.dll')
MultinetGetConnectionPerformanceW = Fiddle::Function.new(
  lib['MultinetGetConnectionPerformanceW'],
  [
    Fiddle::TYPE_VOIDP,  # lpNetResource : NETRESOURCEW*
    Fiddle::TYPE_VOIDP,  # lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "mpr")]
extern "system" {
    fn MultinetGetConnectionPerformanceW(
        lpNetResource: *mut NETRESOURCEW,  // NETRESOURCEW*
        lpNetConnectInfoStruct: *mut NETCONNECTINFOSTRUCT  // NETCONNECTINFOSTRUCT* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Unicode)]
public static extern uint MultinetGetConnectionPerformanceW(IntPtr lpNetResource, IntPtr lpNetConnectInfoStruct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_MultinetGetConnectionPerformanceW' -Namespace Win32 -PassThru
# $api::MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
#uselib "MPR.dll"
#func global MultinetGetConnectionPerformanceW "MultinetGetConnectionPerformanceW" wptr, wptr
; MultinetGetConnectionPerformanceW varptr(lpNetResource), varptr(lpNetConnectInfoStruct)   ; 戻り値は stat
; lpNetResource : NETRESOURCEW* -> "wptr"
; lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPR.dll"
#cfunc global MultinetGetConnectionPerformanceW "MultinetGetConnectionPerformanceW" var, var
; res = MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
; lpNetResource : NETRESOURCEW* -> "var"
; lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MultinetGetConnectionPerformanceW(NETRESOURCEW* lpNetResource, NETCONNECTINFOSTRUCT* lpNetConnectInfoStruct)
#uselib "MPR.dll"
#cfunc global MultinetGetConnectionPerformanceW "MultinetGetConnectionPerformanceW" var, var
; res = MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
; lpNetResource : NETRESOURCEW* -> "var"
; lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mpr = windows.NewLazySystemDLL("MPR.dll")
	procMultinetGetConnectionPerformanceW = mpr.NewProc("MultinetGetConnectionPerformanceW")
)

// lpNetResource (NETRESOURCEW*), lpNetConnectInfoStruct (NETCONNECTINFOSTRUCT* out)
r1, _, err := procMultinetGetConnectionPerformanceW.Call(
	uintptr(lpNetResource),
	uintptr(lpNetConnectInfoStruct),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MultinetGetConnectionPerformanceW(
  lpNetResource: Pointer;   // NETRESOURCEW*
  lpNetConnectInfoStruct: Pointer   // NETCONNECTINFOSTRUCT* out
): DWORD; stdcall;
  external 'MPR.dll' name 'MultinetGetConnectionPerformanceW';
result := DllCall("MPR\MultinetGetConnectionPerformanceW"
    , "Ptr", lpNetResource   ; NETRESOURCEW*
    , "Ptr", lpNetConnectInfoStruct   ; NETCONNECTINFOSTRUCT* out
    , "UInt")   ; return: DWORD
●MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct) = DLL("MPR.dll", "dword MultinetGetConnectionPerformanceW(void*, void*)")
# 呼び出し: MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
# lpNetResource : NETRESOURCEW* -> "void*"
# lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "mpr" fn MultinetGetConnectionPerformanceW(
    lpNetResource: [*c]NETRESOURCEW, // NETRESOURCEW*
    lpNetConnectInfoStruct: [*c]NETCONNECTINFOSTRUCT // NETCONNECTINFOSTRUCT* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MultinetGetConnectionPerformanceW(
    lpNetResource: ptr NETRESOURCEW,  # NETRESOURCEW*
    lpNetConnectInfoStruct: ptr NETCONNECTINFOSTRUCT  # NETCONNECTINFOSTRUCT* out
): uint32 {.importc: "MultinetGetConnectionPerformanceW", stdcall, dynlib: "MPR.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "mpr");
extern(Windows)
uint MultinetGetConnectionPerformanceW(
    NETRESOURCEW* lpNetResource,   // NETRESOURCEW*
    NETCONNECTINFOSTRUCT* lpNetConnectInfoStruct   // NETCONNECTINFOSTRUCT* out
);
ccall((:MultinetGetConnectionPerformanceW, "MPR.dll"), stdcall, UInt32,
      (Ptr{NETRESOURCEW}, Ptr{NETCONNECTINFOSTRUCT}),
      lpNetResource, lpNetConnectInfoStruct)
# lpNetResource : NETRESOURCEW* -> Ptr{NETRESOURCEW}
# lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> Ptr{NETCONNECTINFOSTRUCT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MultinetGetConnectionPerformanceW(
    void* lpNetResource,
    void* lpNetConnectInfoStruct);
]]
local mpr = ffi.load("mpr")
-- mpr.MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
-- lpNetResource : NETRESOURCEW*
-- lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const MultinetGetConnectionPerformanceW = lib.func('__stdcall', 'MultinetGetConnectionPerformanceW', 'uint32_t', ['void *', 'void *']);
// MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
// lpNetResource : NETRESOURCEW* -> 'void *'
// lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPR.dll", {
  MultinetGetConnectionPerformanceW: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct)
// lpNetResource : NETRESOURCEW* -> "pointer"
// lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MultinetGetConnectionPerformanceW(
    void* lpNetResource,
    void* lpNetConnectInfoStruct);
C, "MPR.dll");
// $ffi->MultinetGetConnectionPerformanceW(lpNetResource, lpNetConnectInfoStruct);
// lpNetResource : NETRESOURCEW*
// lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* 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 Mpr extends StdCallLibrary {
    Mpr INSTANCE = Native.load("mpr", Mpr.class, W32APIOptions.UNICODE_OPTIONS);
    int MultinetGetConnectionPerformanceW(
        Pointer lpNetResource,   // NETRESOURCEW*
        Pointer lpNetConnectInfoStruct   // NETCONNECTINFOSTRUCT* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("mpr")]
lib LibMPR
  fun MultinetGetConnectionPerformanceW = MultinetGetConnectionPerformanceW(
    lpNetResource : NETRESOURCEW*,   # NETRESOURCEW*
    lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT*   # NETCONNECTINFOSTRUCT* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MultinetGetConnectionPerformanceWNative = Uint32 Function(Pointer<Void>, Pointer<Void>);
typedef MultinetGetConnectionPerformanceWDart = int Function(Pointer<Void>, Pointer<Void>);
final MultinetGetConnectionPerformanceW = DynamicLibrary.open('MPR.dll')
    .lookupFunction<MultinetGetConnectionPerformanceWNative, MultinetGetConnectionPerformanceWDart>('MultinetGetConnectionPerformanceW');
// lpNetResource : NETRESOURCEW* -> Pointer<Void>
// lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MultinetGetConnectionPerformanceW(
  lpNetResource: Pointer;   // NETRESOURCEW*
  lpNetConnectInfoStruct: Pointer   // NETCONNECTINFOSTRUCT* out
): DWORD; stdcall;
  external 'MPR.dll' name 'MultinetGetConnectionPerformanceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MultinetGetConnectionPerformanceW"
  c_MultinetGetConnectionPerformanceW :: Ptr () -> Ptr () -> IO Word32
-- lpNetResource : NETRESOURCEW* -> Ptr ()
-- lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let multinetgetconnectionperformancew =
  foreign "MultinetGetConnectionPerformanceW"
    ((ptr void) @-> (ptr void) @-> returning uint32_t)
(* lpNetResource : NETRESOURCEW* -> (ptr void) *)
(* lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mpr (t "MPR.dll"))
(cffi:use-foreign-library mpr)

(cffi:defcfun ("MultinetGetConnectionPerformanceW" multinet-get-connection-performance-w :convention :stdcall) :uint32
  (lp-net-resource :pointer)   ; NETRESOURCEW*
  (lp-net-connect-info-struct :pointer))   ; NETCONNECTINFOSTRUCT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MultinetGetConnectionPerformanceW = Win32::API::More->new('MPR',
    'DWORD MultinetGetConnectionPerformanceW(LPVOID lpNetResource, LPVOID lpNetConnectInfoStruct)');
# my $ret = $MultinetGetConnectionPerformanceW->Call($lpNetResource, $lpNetConnectInfoStruct);
# lpNetResource : NETRESOURCEW* -> LPVOID
# lpNetConnectInfoStruct : NETCONNECTINFOSTRUCT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型