ホーム › NetworkManagement.NetManagement › NetUseGetInfo

NetUseGetInfo

関数

指定したネットワーク接続の情報を取得する。

DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetUseGetInfo(
    LPWSTR UncServerName,   // optional
    LPWSTR UseName,
    DWORD LevelFlags,
    BYTE** bufptr   // optional
);

パラメーター

名前

型

方向

説明

UncServerName

LPWSTR

inoptional

この関数を実行するコンピューターの UNC 名。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。UncServerName パラメーターにリモートコンピューターを指定する場合、そのリモートコンピューターはレガシーなリモートアクセスプロトコル機構を用いたリモート RPC 呼び出しをサポートしている必要があります。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode です。

UseName

LPWSTR

情報を返す対象となる接続の名前を指定する文字列へのポインター。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode です。

LevelFlags

DWORD

要求するデータの情報レベル。このパラメーターには次のいずれかの値を指定できます。

値	意味
0	ローカルデバイス名とリモートリソースの共有名を指定します。BufPtr パラメーターは USE_INFO_0 構造体へのポインターです。
1	ローカルデバイスと共有リソースの間の接続に関する情報を指定します。これには接続の状態と種類が含まれます。BufPtr パラメーターは USE_INFO_1 構造体へのポインターです。
2	ローカルデバイスと共有リソースの間の接続に関する情報を指定します。この情報には、接続の状態、接続の種類、ユーザー名、ドメイン名が含まれます。BufPtr パラメーターは USE_INFO_2 構造体へのポインターです。

bufptr

BYTE**

outoptional

データを受け取るバッファーへのポインター。このデータの形式は Level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetUseGetInfo 関数は、共有リソースへの接続に関する情報を取得します。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、 System Error Codes を参照してください。

解説(Remarks)

NetUseGetInfo 関数を呼び出すために特別なグループメンバーシップは必要ありません。この関数は、下位互換のための場合を除き、リモートサーバー上で実行することはできません。

ローカルコンピューターとリモートサーバー上のリソースとの間の現在のすべての接続を一覧表示するには、 NetUseEnum 関数を呼び出します。

この関数は、Server Message Block (LAN Manager Workstation) クライアントにのみ適用されます。NetUseGetInfo 関数は、分散ファイルシステム (DFS) 共有をサポートしません。別のネットワークプロバイダー (WebDAV や DFS 共有など) を使用する共有の情報を取得するには、WNetGetConnection 関数を使用してください。

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

各言語での呼び出し定義

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

DWORD NetUseGetInfo(
    LPWSTR UncServerName,   // optional
    LPWSTR UseName,
    DWORD LevelFlags,
    BYTE** bufptr   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetUseGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string UncServerName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string UseName,   // LPWSTR
    uint LevelFlags,   // DWORD
    IntPtr bufptr   // BYTE** optional, out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetUseGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> UncServerName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> UseName As String,   ' LPWSTR
    LevelFlags As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE** optional, out
) As UInteger
End Function

' UncServerName : LPWSTR optional
' UseName : LPWSTR
' LevelFlags : DWORD
' bufptr : BYTE** optional, out
Declare PtrSafe Function NetUseGetInfo Lib "netapi32" ( _
    ByVal UncServerName As LongPtr, _
    ByVal UseName As LongPtr, _
    ByVal LevelFlags As Long, _
    ByVal bufptr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetUseGetInfo = ctypes.windll.netapi32.NetUseGetInfo
NetUseGetInfo.restype = wintypes.DWORD
NetUseGetInfo.argtypes = [
    wintypes.LPCWSTR,  # UncServerName : LPWSTR optional
    wintypes.LPCWSTR,  # UseName : LPWSTR
    wintypes.DWORD,  # LevelFlags : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetUseGetInfo = Fiddle::Function.new(
  lib['NetUseGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # UncServerName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # UseName : LPWSTR
    -Fiddle::TYPE_INT,  # LevelFlags : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetUseGetInfo(
        UncServerName: *mut u16,  // LPWSTR optional
        UseName: *mut u16,  // LPWSTR
        LevelFlags: u32,  // DWORD
        bufptr: *mut *mut u8  // BYTE** optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetUseGetInfo([MarshalAs(UnmanagedType.LPWStr)] string UncServerName, [MarshalAs(UnmanagedType.LPWStr)] string UseName, uint LevelFlags, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetUseGetInfo' -Namespace Win32 -PassThru
# $api::NetUseGetInfo(UncServerName, UseName, LevelFlags, bufptr)

#uselib "NETAPI32.dll"
#func global NetUseGetInfo "NetUseGetInfo" sptr, sptr, sptr, sptr
; NetUseGetInfo UncServerName, UseName, LevelFlags, varptr(bufptr)   ; 戻り値は stat
; UncServerName : LPWSTR optional -> "sptr"
; UseName : LPWSTR -> "sptr"
; LevelFlags : DWORD -> "sptr"
; bufptr : BYTE** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetUseGetInfo "NetUseGetInfo" wstr, wstr, int, var
; res = NetUseGetInfo(UncServerName, UseName, LevelFlags, bufptr)
; UncServerName : LPWSTR optional -> "wstr"
; UseName : LPWSTR -> "wstr"
; LevelFlags : DWORD -> "int"
; bufptr : BYTE** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetUseGetInfo "NetUseGetInfo" wstr, wstr, int, sptr
; res = NetUseGetInfo(UncServerName, UseName, LevelFlags, varptr(bufptr))
; UncServerName : LPWSTR optional -> "wstr"
; UseName : LPWSTR -> "wstr"
; LevelFlags : DWORD -> "int"
; bufptr : BYTE** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。