Win32 API 日本語リファレンス
ホームStorage.FileSystem › NetServerAliasEnum

NetServerAliasEnum

関数
サーバーのエイリアス名を列挙する。
DLLNETAPI32.dll呼出規約winapi

シグネチャ

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

DWORD NetServerAliasEnum(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    DWORD* resumehandle   // optional
);

パラメーター

名前方向説明
servernameLPWSTRinoptional列挙対象のサーバ名(UNC形式)。NULLでローカルを対象とする。
levelDWORDin返す情報構造体の種別を示すレベル番号(通常0)。
bufptrBYTE**out列挙結果を格納したバッファのアドレスを受け取るポインタ。NetApiBufferFreeで解放する。
prefmaxlenDWORDin返すデータの推奨最大バイト数。MAX_PREFERRED_LENGTHで上限なし。
entriesreadDWORD*out実際に読み取られたエントリ数を受け取る出力先へのポインタ。
totalentriesDWORD*out利用可能な総エントリ数を受け取る出力先へのポインタ。
resumehandleDWORD*inoutoptional列挙継続用の再開ハンドルへのポインタ。初回は0。NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD NetServerAliasEnum(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    DWORD* resumehandle   // optional
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetServerAliasEnum(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    uint level,   // DWORD
    IntPtr bufptr,   // BYTE** out
    uint prefmaxlen,   // DWORD
    out uint entriesread,   // DWORD* out
    out uint totalentries,   // DWORD* out
    IntPtr resumehandle   // DWORD* optional, in/out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetServerAliasEnum(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    level As UInteger,   ' DWORD
    bufptr As IntPtr,   ' BYTE** out
    prefmaxlen As UInteger,   ' DWORD
    <Out> ByRef entriesread As UInteger,   ' DWORD* out
    <Out> ByRef totalentries As UInteger,   ' DWORD* out
    resumehandle As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' servername : LPWSTR optional
' level : DWORD
' bufptr : BYTE** out
' prefmaxlen : DWORD
' entriesread : DWORD* out
' totalentries : DWORD* out
' resumehandle : DWORD* optional, in/out
Declare PtrSafe Function NetServerAliasEnum Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal level As Long, _
    ByVal bufptr As LongPtr, _
    ByVal prefmaxlen As Long, _
    ByRef entriesread As Long, _
    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

NetServerAliasEnum = ctypes.windll.netapi32.NetServerAliasEnum
NetServerAliasEnum.restype = wintypes.DWORD
NetServerAliasEnum.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
    wintypes.DWORD,  # prefmaxlen : DWORD
    ctypes.POINTER(wintypes.DWORD),  # entriesread : DWORD* 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')
NetServerAliasEnum = Fiddle::Function.new(
  lib['NetServerAliasEnum'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** out
    -Fiddle::TYPE_INT,  # prefmaxlen : DWORD
    Fiddle::TYPE_VOIDP,  # entriesread : DWORD* out
    Fiddle::TYPE_VOIDP,  # totalentries : DWORD* out
    Fiddle::TYPE_VOIDP,  # resumehandle : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetServerAliasEnum(
        servername: *mut u16,  // LPWSTR optional
        level: u32,  // DWORD
        bufptr: *mut *mut u8,  // BYTE** out
        prefmaxlen: u32,  // DWORD
        entriesread: *mut u32,  // DWORD* 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 NetServerAliasEnum([MarshalAs(UnmanagedType.LPWStr)] string servername, uint level, IntPtr bufptr, uint prefmaxlen, out uint entriesread, out uint totalentries, IntPtr resumehandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetServerAliasEnum' -Namespace Win32 -PassThru
# $api::NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
#uselib "NETAPI32.dll"
#func global NetServerAliasEnum "NetServerAliasEnum" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NetServerAliasEnum servername, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resumehandle)   ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE** out -> "sptr"
; prefmaxlen : DWORD -> "sptr"
; entriesread : DWORD* out -> "sptr"
; totalentries : DWORD* out -> "sptr"
; resumehandle : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetServerAliasEnum "NetServerAliasEnum" wstr, int, var, int, var, var, var
; res = NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "var"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "var"
; totalentries : DWORD* out -> "var"
; resumehandle : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetServerAliasEnum(LPWSTR servername, DWORD level, BYTE** bufptr, DWORD prefmaxlen, DWORD* entriesread, DWORD* totalentries, DWORD* resumehandle)
#uselib "NETAPI32.dll"
#cfunc global NetServerAliasEnum "NetServerAliasEnum" wstr, int, var, int, var, var, var
; res = NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "var"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "var"
; totalentries : DWORD* out -> "var"
; resumehandle : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetServerAliasEnum = netapi32.NewProc("NetServerAliasEnum")
)

// servername (LPWSTR optional), level (DWORD), bufptr (BYTE** out), prefmaxlen (DWORD), entriesread (DWORD* out), totalentries (DWORD* out), resumehandle (DWORD* optional, in/out)
r1, _, err := procNetServerAliasEnum.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
	uintptr(level),
	uintptr(bufptr),
	uintptr(prefmaxlen),
	uintptr(entriesread),
	uintptr(totalentries),
	uintptr(resumehandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetServerAliasEnum(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer;   // BYTE** out
  prefmaxlen: DWORD;   // DWORD
  entriesread: Pointer;   // DWORD* out
  totalentries: Pointer;   // DWORD* out
  resumehandle: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetServerAliasEnum';
result := DllCall("NETAPI32\NetServerAliasEnum"
    , "WStr", servername   ; LPWSTR optional
    , "UInt", level   ; DWORD
    , "Ptr", bufptr   ; BYTE** out
    , "UInt", prefmaxlen   ; DWORD
    , "Ptr", entriesread   ; DWORD* out
    , "Ptr", totalentries   ; DWORD* out
    , "Ptr", resumehandle   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD
●NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle) = DLL("NETAPI32.dll", "dword NetServerAliasEnum(char*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
# servername : LPWSTR optional -> "char*"
# level : DWORD -> "dword"
# bufptr : BYTE** out -> "void*"
# prefmaxlen : DWORD -> "dword"
# entriesread : DWORD* 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 NetServerAliasEnum(
    servername: [*c]const u16, // LPWSTR optional
    level: u32, // DWORD
    bufptr: [*c][*c]u8, // BYTE** out
    prefmaxlen: u32, // DWORD
    entriesread: [*c]u32, // DWORD* out
    totalentries: [*c]u32, // DWORD* out
    resumehandle: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) u32;
proc NetServerAliasEnum(
    servername: WideCString,  # LPWSTR optional
    level: uint32,  # DWORD
    bufptr: ptr uint8,  # BYTE** out
    prefmaxlen: uint32,  # DWORD
    entriesread: ptr uint32,  # DWORD* out
    totalentries: ptr uint32,  # DWORD* out
    resumehandle: ptr uint32  # DWORD* optional, in/out
): uint32 {.importc: "NetServerAliasEnum", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetServerAliasEnum(
    const(wchar)* servername,   // LPWSTR optional
    uint level,   // DWORD
    ubyte** bufptr,   // BYTE** out
    uint prefmaxlen,   // DWORD
    uint* entriesread,   // DWORD* out
    uint* totalentries,   // DWORD* out
    uint* resumehandle   // DWORD* optional, in/out
);
ccall((:NetServerAliasEnum, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
      servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
# servername : LPWSTR optional -> Cwstring
# level : DWORD -> UInt32
# bufptr : BYTE** out -> Ptr{UInt8}
# prefmaxlen : DWORD -> UInt32
# entriesread : DWORD* 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 NetServerAliasEnum(
    const uint16_t* servername,
    uint32_t level,
    uint8_t** bufptr,
    uint32_t prefmaxlen,
    uint32_t* entriesread,
    uint32_t* totalentries,
    uint32_t* resumehandle);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
-- servername : LPWSTR optional
-- level : DWORD
-- bufptr : BYTE** out
-- prefmaxlen : DWORD
-- entriesread : DWORD* 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 NetServerAliasEnum = lib.func('__stdcall', 'NetServerAliasEnum', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
// servername : LPWSTR optional -> 'str16'
// level : DWORD -> 'uint32_t'
// bufptr : BYTE** out -> 'uint8_t *'
// prefmaxlen : DWORD -> 'uint32_t'
// entriesread : DWORD* 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", {
  NetServerAliasEnum: { parameters: ["buffer", "u32", "pointer", "u32", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle)
// servername : LPWSTR optional -> "buffer"
// level : DWORD -> "u32"
// bufptr : BYTE** out -> "pointer"
// prefmaxlen : DWORD -> "u32"
// entriesread : DWORD* 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 NetServerAliasEnum(
    const uint16_t* servername,
    uint32_t level,
    uint8_t** bufptr,
    uint32_t prefmaxlen,
    uint32_t* entriesread,
    uint32_t* totalentries,
    uint32_t* resumehandle);
C, "NETAPI32.dll");
// $ffi->NetServerAliasEnum(servername, level, bufptr, prefmaxlen, entriesread, totalentries, resumehandle);
// servername : LPWSTR optional
// level : DWORD
// bufptr : BYTE** out
// prefmaxlen : DWORD
// entriesread : DWORD* 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 NetServerAliasEnum(
        WString servername,   // LPWSTR optional
        int level,   // DWORD
        Pointer bufptr,   // BYTE** out
        int prefmaxlen,   // DWORD
        IntByReference entriesread,   // DWORD* out
        IntByReference totalentries,   // DWORD* out
        IntByReference resumehandle   // DWORD* optional, in/out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetServerAliasEnum = NetServerAliasEnum(
    servername : UInt16*,   # LPWSTR optional
    level : UInt32,   # DWORD
    bufptr : UInt8**,   # BYTE** out
    prefmaxlen : UInt32,   # DWORD
    entriesread : UInt32*,   # DWORD* 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 NetServerAliasEnumNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef NetServerAliasEnumDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final NetServerAliasEnum = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetServerAliasEnumNative, NetServerAliasEnumDart>('NetServerAliasEnum');
// servername : LPWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE** out -> Pointer<Uint8>
// prefmaxlen : DWORD -> Uint32
// entriesread : DWORD* out -> Pointer<Uint32>
// totalentries : DWORD* out -> Pointer<Uint32>
// resumehandle : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetServerAliasEnum(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer;   // BYTE** out
  prefmaxlen: DWORD;   // DWORD
  entriesread: Pointer;   // DWORD* out
  totalentries: Pointer;   // DWORD* out
  resumehandle: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetServerAliasEnum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetServerAliasEnum"
  c_NetServerAliasEnum :: CWString -> Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- level : DWORD -> Word32
-- bufptr : BYTE** out -> Ptr Word8
-- prefmaxlen : DWORD -> Word32
-- entriesread : DWORD* 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 netserveraliasenum =
  foreign "NetServerAliasEnum"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : BYTE** out -> (ptr uint8_t) *)
(* prefmaxlen : DWORD -> uint32_t *)
(* entriesread : DWORD* 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 ("NetServerAliasEnum" net-server-alias-enum :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (level :uint32)   ; DWORD
  (bufptr :pointer)   ; BYTE** out
  (prefmaxlen :uint32)   ; DWORD
  (entriesread :pointer)   ; DWORD* out
  (totalentries :pointer)   ; DWORD* out
  (resumehandle :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetServerAliasEnum = Win32::API::More->new('NETAPI32',
    'DWORD NetServerAliasEnum(LPCWSTR servername, DWORD level, LPVOID bufptr, DWORD prefmaxlen, LPVOID entriesread, LPVOID totalentries, LPVOID resumehandle)');
# my $ret = $NetServerAliasEnum->Call($servername, $level, $bufptr, $prefmaxlen, $entriesread, $totalentries, $resumehandle);
# servername : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** out -> LPVOID
# prefmaxlen : DWORD -> DWORD
# entriesread : DWORD* out -> LPVOID
# totalentries : DWORD* out -> LPVOID
# resumehandle : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。