ホーム › NetworkManagement.NetManagement › NetUseEnum

NetUseEnum

関数

現在のネットワーク接続を列挙する。

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

シグネチャ

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

DWORD NetUseEnum(
    LPWSTR UncServerName,   // optional
    DWORD LevelFlags,
    BYTE** BufPtr,   // optional
    DWORD PreferedMaximumSize,
    DWORD* EntriesRead,   // optional
    DWORD* TotalEntries,
    DWORD* ResumeHandle   // optional
);

パラメーター

名前

型

方向

説明

UncServerName

LPWSTR

inoptional

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

_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 関数を使用して解放する必要があります。なお、関数が ERROR_MORE_DATA で失敗した場合でも、バッファーを解放する必要があります。

PreferedMaximumSize

DWORD

返すデータの推奨される最大長(バイト単位)。MAX_PREFERRED_LENGTH を指定した場合、関数はデータに必要なメモリ量を割り当てます。このパラメーターに別の値を指定した場合、関数が返すバイト数を制限できます。バッファーサイズがすべてのエントリを保持するのに不十分な場合、関数は ERROR_MORE_DATA を返します。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

EntriesRead

DWORD*

outoptional

実際に列挙された要素の数を受け取る値へのポインター。

TotalEntries

DWORD*

out

現在の再開位置から列挙できたであろうエントリの総数を受け取る値へのポインター。なお、アプリケーションはこの値を目安としてのみ扱うべきです。

ResumeHandle

DWORD*

inoutoptional

検索を継続するために使用される再開ハンドルを格納する値へのポインター。このハンドルは、最初の呼び出しではゼロにし、以降の呼び出しでは変更せずにそのまま使用する必要があります。ResumeHandle が NULL の場合、再開ハンドルは格納されません。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、BufPtr または entriesread パラメーターに NULL ポインターが渡された場合に返されます。
ERROR_MORE_DATA	返すべきデータがさらにあります。このエラーは、バッファーサイズがすべてのエントリを保持するのに不十分な場合に返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、UncServerName パラメーターが NULL ではなく、かつリモートサーバーがレガシーな Remote Access Protocol 機構を使用したリモート RPC 呼び出しをサポートしていない場合に返されます。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

1 つのネットワーク接続に関する情報を取得するには、 NetUseGetInfo 関数を呼び出すことができます。

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

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

各言語での呼び出し定義

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

DWORD NetUseEnum(
    LPWSTR UncServerName,   // optional
    DWORD LevelFlags,
    BYTE** BufPtr,   // optional
    DWORD PreferedMaximumSize,
    DWORD* EntriesRead,   // optional
    DWORD* TotalEntries,
    DWORD* ResumeHandle   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetUseEnum(
    [MarshalAs(UnmanagedType.LPWStr)] string UncServerName,   // LPWSTR optional
    uint LevelFlags,   // DWORD
    IntPtr BufPtr,   // BYTE** optional, out
    uint PreferedMaximumSize,   // DWORD
    IntPtr EntriesRead,   // DWORD* optional, out
    out uint TotalEntries,   // DWORD* out
    IntPtr ResumeHandle   // DWORD* optional, in/out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetUseEnum(
    <MarshalAs(UnmanagedType.LPWStr)> UncServerName As String,   ' LPWSTR optional
    LevelFlags As UInteger,   ' DWORD
    BufPtr As IntPtr,   ' BYTE** optional, out
    PreferedMaximumSize As UInteger,   ' DWORD
    EntriesRead As IntPtr,   ' DWORD* optional, out
    <Out> ByRef TotalEntries As UInteger,   ' DWORD* out
    ResumeHandle As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' UncServerName : LPWSTR optional
' LevelFlags : DWORD
' BufPtr : BYTE** optional, out
' PreferedMaximumSize : DWORD
' EntriesRead : DWORD* optional, out
' TotalEntries : DWORD* out
' ResumeHandle : DWORD* optional, in/out
Declare PtrSafe Function NetUseEnum Lib "netapi32" ( _
    ByVal UncServerName As LongPtr, _
    ByVal LevelFlags As Long, _
    ByVal BufPtr As LongPtr, _
    ByVal PreferedMaximumSize As Long, _
    ByVal EntriesRead As LongPtr, _
    ByRef TotalEntries As Long, _
    ByVal ResumeHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetUseEnum = ctypes.windll.netapi32.NetUseEnum
NetUseEnum.restype = wintypes.DWORD
NetUseEnum.argtypes = [
    wintypes.LPCWSTR,  # UncServerName : LPWSTR optional
    wintypes.DWORD,  # LevelFlags : DWORD
    ctypes.c_void_p,  # BufPtr : BYTE** optional, out
    wintypes.DWORD,  # PreferedMaximumSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # EntriesRead : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # TotalEntries : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetUseEnum = Fiddle::Function.new(
  lib['NetUseEnum'],
  [
    Fiddle::TYPE_VOIDP,  # UncServerName : LPWSTR optional
    -Fiddle::TYPE_INT,  # LevelFlags : DWORD
    Fiddle::TYPE_VOIDP,  # BufPtr : BYTE** optional, out
    -Fiddle::TYPE_INT,  # PreferedMaximumSize : DWORD
    Fiddle::TYPE_VOIDP,  # EntriesRead : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # TotalEntries : DWORD* out
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetUseEnum([MarshalAs(UnmanagedType.LPWStr)] string UncServerName, uint LevelFlags, IntPtr BufPtr, uint PreferedMaximumSize, IntPtr EntriesRead, out uint TotalEntries, IntPtr ResumeHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetUseEnum' -Namespace Win32 -PassThru
# $api::NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)

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

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetUseEnum = netapi32.NewProc("NetUseEnum")
)

// UncServerName (LPWSTR optional), LevelFlags (DWORD), BufPtr (BYTE** optional, out), PreferedMaximumSize (DWORD), EntriesRead (DWORD* optional, out), TotalEntries (DWORD* out), ResumeHandle (DWORD* optional, in/out)
r1, _, err := procNetUseEnum.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(UncServerName))),
	uintptr(LevelFlags),
	uintptr(BufPtr),
	uintptr(PreferedMaximumSize),
	uintptr(EntriesRead),
	uintptr(TotalEntries),
	uintptr(ResumeHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function NetUseEnum(
  UncServerName: PWideChar;   // LPWSTR optional
  LevelFlags: DWORD;   // DWORD
  BufPtr: Pointer;   // BYTE** optional, out
  PreferedMaximumSize: DWORD;   // DWORD
  EntriesRead: Pointer;   // DWORD* optional, out
  TotalEntries: Pointer;   // DWORD* out
  ResumeHandle: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetUseEnum';

result := DllCall("NETAPI32\NetUseEnum"
    , "WStr", UncServerName   ; LPWSTR optional
    , "UInt", LevelFlags   ; DWORD
    , "Ptr", BufPtr   ; BYTE** optional, out
    , "UInt", PreferedMaximumSize   ; DWORD
    , "Ptr", EntriesRead   ; DWORD* optional, out
    , "Ptr", TotalEntries   ; DWORD* out
    , "Ptr", ResumeHandle   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD

●NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle) = DLL("NETAPI32.dll", "dword NetUseEnum(char*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)
# UncServerName : LPWSTR optional -> "char*"
# LevelFlags : DWORD -> "dword"
# BufPtr : BYTE** optional, out -> "void*"
# PreferedMaximumSize : DWORD -> "dword"
# EntriesRead : DWORD* optional, out -> "void*"
# TotalEntries : DWORD* out -> "void*"
# ResumeHandle : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "netapi32" fn NetUseEnum(
    UncServerName: [*c]const u16, // LPWSTR optional
    LevelFlags: u32, // DWORD
    BufPtr: [*c][*c]u8, // BYTE** optional, out
    PreferedMaximumSize: u32, // DWORD
    EntriesRead: [*c]u32, // DWORD* optional, out
    TotalEntries: [*c]u32, // DWORD* out
    ResumeHandle: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) u32;

proc NetUseEnum(
    UncServerName: WideCString,  # LPWSTR optional
    LevelFlags: uint32,  # DWORD
    BufPtr: ptr uint8,  # BYTE** optional, out
    PreferedMaximumSize: uint32,  # DWORD
    EntriesRead: ptr uint32,  # DWORD* optional, out
    TotalEntries: ptr uint32,  # DWORD* out
    ResumeHandle: ptr uint32  # DWORD* optional, in/out
): uint32 {.importc: "NetUseEnum", stdcall, dynlib: "NETAPI32.dll".}

pragma(lib, "netapi32");
extern(Windows)
uint NetUseEnum(
    const(wchar)* UncServerName,   // LPWSTR optional
    uint LevelFlags,   // DWORD
    ubyte** BufPtr,   // BYTE** optional, out
    uint PreferedMaximumSize,   // DWORD
    uint* EntriesRead,   // DWORD* optional, out
    uint* TotalEntries,   // DWORD* out
    uint* ResumeHandle   // DWORD* optional, in/out
);

ccall((:NetUseEnum, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
      UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)
# UncServerName : LPWSTR optional -> Cwstring
# LevelFlags : DWORD -> UInt32
# BufPtr : BYTE** optional, out -> Ptr{UInt8}
# PreferedMaximumSize : DWORD -> UInt32
# EntriesRead : DWORD* optional, out -> Ptr{UInt32}
# TotalEntries : DWORD* out -> Ptr{UInt32}
# ResumeHandle : DWORD* optional, in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t NetUseEnum(
    const uint16_t* UncServerName,
    uint32_t LevelFlags,
    uint8_t** BufPtr,
    uint32_t PreferedMaximumSize,
    uint32_t* EntriesRead,
    uint32_t* TotalEntries,
    uint32_t* ResumeHandle);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)
-- UncServerName : LPWSTR optional
-- LevelFlags : DWORD
-- BufPtr : BYTE** optional, out
-- PreferedMaximumSize : DWORD
-- EntriesRead : DWORD* optional, out
-- TotalEntries : DWORD* out
-- ResumeHandle : DWORD* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetUseEnum = lib.func('__stdcall', 'NetUseEnum', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)
// UncServerName : LPWSTR optional -> 'str16'
// LevelFlags : DWORD -> 'uint32_t'
// BufPtr : BYTE** optional, out -> 'uint8_t *'
// PreferedMaximumSize : DWORD -> 'uint32_t'
// EntriesRead : DWORD* optional, out -> 'uint32_t *'
// TotalEntries : DWORD* out -> 'uint32_t *'
// ResumeHandle : DWORD* optional, in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("NETAPI32.dll", {
  NetUseEnum: { parameters: ["buffer", "u32", "pointer", "u32", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle)
// UncServerName : LPWSTR optional -> "buffer"
// LevelFlags : DWORD -> "u32"
// BufPtr : BYTE** optional, out -> "pointer"
// PreferedMaximumSize : DWORD -> "u32"
// EntriesRead : DWORD* optional, out -> "pointer"
// TotalEntries : DWORD* out -> "pointer"
// ResumeHandle : DWORD* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t NetUseEnum(
    const uint16_t* UncServerName,
    uint32_t LevelFlags,
    uint8_t** BufPtr,
    uint32_t PreferedMaximumSize,
    uint32_t* EntriesRead,
    uint32_t* TotalEntries,
    uint32_t* ResumeHandle);
C, "NETAPI32.dll");
// $ffi->NetUseEnum(UncServerName, LevelFlags, BufPtr, PreferedMaximumSize, EntriesRead, TotalEntries, ResumeHandle);
// UncServerName : LPWSTR optional
// LevelFlags : DWORD
// BufPtr : BYTE** optional, out
// PreferedMaximumSize : DWORD
// EntriesRead : DWORD* optional, out
// TotalEntries : DWORD* out
// ResumeHandle : DWORD* optional, 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 Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int NetUseEnum(
        WString UncServerName,   // LPWSTR optional
        int LevelFlags,   // DWORD
        Pointer BufPtr,   // BYTE** optional, out
        int PreferedMaximumSize,   // DWORD
        IntByReference EntriesRead,   // DWORD* optional, out
        IntByReference TotalEntries,   // DWORD* out
        IntByReference ResumeHandle   // DWORD* optional, in/out
    );
}

@[Link("netapi32")]
lib LibNETAPI32
  fun NetUseEnum = NetUseEnum(
    UncServerName : UInt16*,   # LPWSTR optional
    LevelFlags : UInt32,   # DWORD
    BufPtr : UInt8**,   # BYTE** optional, out
    PreferedMaximumSize : UInt32,   # DWORD
    EntriesRead : UInt32*,   # DWORD* optional, out
    TotalEntries : UInt32*,   # DWORD* out
    ResumeHandle : UInt32*   # DWORD* optional, 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 NetUseEnumNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef NetUseEnumDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final NetUseEnum = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetUseEnumNative, NetUseEnumDart>('NetUseEnum');
// UncServerName : LPWSTR optional -> Pointer<Utf16>
// LevelFlags : DWORD -> Uint32
// BufPtr : BYTE** optional, out -> Pointer<Uint8>
// PreferedMaximumSize : DWORD -> Uint32
// EntriesRead : DWORD* optional, out -> Pointer<Uint32>
// TotalEntries : DWORD* out -> Pointer<Uint32>
// ResumeHandle : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function NetUseEnum(
  UncServerName: PWideChar;   // LPWSTR optional
  LevelFlags: DWORD;   // DWORD
  BufPtr: Pointer;   // BYTE** optional, out
  PreferedMaximumSize: DWORD;   // DWORD
  EntriesRead: Pointer;   // DWORD* optional, out
  TotalEntries: Pointer;   // DWORD* out
  ResumeHandle: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetUseEnum';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetUseEnum"
  c_NetUseEnum :: CWString -> Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- UncServerName : LPWSTR optional -> CWString
-- LevelFlags : DWORD -> Word32
-- BufPtr : BYTE** optional, out -> Ptr Word8
-- PreferedMaximumSize : DWORD -> Word32
-- EntriesRead : DWORD* optional, out -> Ptr Word32
-- TotalEntries : DWORD* out -> Ptr Word32
-- ResumeHandle : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let netuseenum =
  foreign "NetUseEnum"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* UncServerName : LPWSTR optional -> (ptr uint16_t) *)
(* LevelFlags : DWORD -> uint32_t *)
(* BufPtr : BYTE** optional, out -> (ptr uint8_t) *)
(* PreferedMaximumSize : DWORD -> uint32_t *)
(* EntriesRead : DWORD* optional, out -> (ptr uint32_t) *)
(* TotalEntries : DWORD* out -> (ptr uint32_t) *)
(* ResumeHandle : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetUseEnum" net-use-enum :convention :stdcall) :uint32
  (unc-server-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (level-flags :uint32)   ; DWORD
  (buf-ptr :pointer)   ; BYTE** optional, out
  (prefered-maximum-size :uint32)   ; DWORD
  (entries-read :pointer)   ; DWORD* optional, out
  (total-entries :pointer)   ; DWORD* out
  (resume-handle :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $NetUseEnum = Win32::API::More->new('NETAPI32',
    'DWORD NetUseEnum(LPCWSTR UncServerName, DWORD LevelFlags, LPVOID BufPtr, DWORD PreferedMaximumSize, LPVOID EntriesRead, LPVOID TotalEntries, LPVOID ResumeHandle)');
# my $ret = $NetUseEnum->Call($UncServerName, $LevelFlags, $BufPtr, $PreferedMaximumSize, $EntriesRead, $TotalEntries, $ResumeHandle);
# UncServerName : LPWSTR optional -> LPCWSTR
# LevelFlags : DWORD -> DWORD
# BufPtr : BYTE** optional, out -> LPVOID
# PreferedMaximumSize : DWORD -> DWORD
# EntriesRead : DWORD* optional, out -> LPVOID
# TotalEntries : DWORD* out -> LPVOID
# ResumeHandle : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

NetUseEnum

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目