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

NetWkstaGetInfo

関数
ワークステーションの構成情報を取得する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetWkstaGetInfo(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr   // optional
);

パラメーター

名前方向説明
servernameLPWSTRinoptional関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
levelDWORDin

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

意味
100
ワークステーション環境に関する情報を返します。これには、プラットフォーム固有の情報、ドメイン名およびローカルコンピューター名、オペレーティングシステムに関する情報が含まれます。bufptr パラメーターは WKSTA_INFO_100 構造体を指します。
101
レベル 100 の情報に加えて、LANMAN ディレクトリへのパスを返します。bufptr パラメーターは WKSTA_INFO_101 構造体を指します。
102
レベル 101 の情報に加えて、ローカルコンピューターにログオンしているユーザー数を返します。bufptr パラメーターは WKSTA_INFO_102 構造体を指します。
bufptrBYTE**outoptionalデータを受け取るバッファーへのポインターです。このデータの形式は level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetWkstaGetInfo 関数は、ワークステーションの構成に関する情報を返します。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
ユーザーが要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL
level パラメーターが無効です。

解説(Remarks)

Windows Server 2003 および Windows XP: Active Directory を実行しているドメインコントローラー上でこの関数を呼び出した場合、アクセスはセキュリティ保護可能なオブジェクトの ACL に基づいて許可または拒否されます。匿名アクセスを有効にするには、ユーザー Anonymous が「Pre-Windows 2000 compatible access」グループのメンバーである必要があります。これは、匿名トークンには既定で Everyone グループ SID が含まれていないためです。メンバーサーバーまたはワークステーション上でこの関数を呼び出した場合、認証されたすべてのユーザーが情報を参照できます。また、EveryoneIncludesAnonymous ポリシー設定が匿名アクセスを許可している場合も、匿名アクセスが許可されます。レベル 100 では、匿名アクセスが常に許可されます。レベル 101 でこの関数を呼び出した場合、認証されたユーザーが情報を参照できます。Administrators、Server、System、Print Operator の各ローカルグループのメンバーは、レベル 102 および 502 の情報を参照できます。匿名アクセスの制限の詳細については、 Security Requirements for the Network Management Functions を参照してください。ACL、ACE、およびアクセストークンの詳細については、 Access Control Model を参照してください。

Windows 2000: Active Directory を実行しているドメインコントローラー上でこの関数を呼び出した場合、アクセスはセキュリティ保護可能なオブジェクトのアクセス制御リスト (ACL) に基づいて許可または拒否されます。既定の ACL では、認証されたすべてのユーザーと「 Pre-Windows 2000 compatible access」グループのメンバーが情報を参照できます。既定では、「Pre-Windows 2000 compatible access」グループには Everyone がメンバーとして含まれています。これにより、システムが匿名アクセスを許可している場合、情報への匿名アクセスが有効になります。メンバーサーバーまたはワークステーション上でこの関数を呼び出した場合、認証されたすべてのユーザーが情報を参照できます。また、RestrictAnonymous ポリシー設定が匿名アクセスを許可している場合も、匿名アクセスが許可されます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0400 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

次のコードサンプルは、 NetWkstaGetInfo 関数の呼び出しを使用して、ワークステーションの構成要素に関する情報を取得する方法を示しています。このサンプルでは、情報レベル 102 ( WKSTA_INFO_102) を指定して NetWkstaGetInfo を呼び出します。呼び出しが成功した場合、サンプルはワークステーションに関する情報を出力します。最後に、コードサンプルは情報バッファーに割り当てられたメモリを解放します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 102;
   LPWKSTA_INFO_102 pBuf = NULL;
   NET_API_STATUS nStatus;
   LPWSTR pszServerName = NULL;
   //
   // Check command line arguments.
   //
   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = argv[1];
   //
   // Call the NetWkstaGetInfo function, specifying level 102.
   //
   nStatus = NetWkstaGetInfo(pszServerName,
                             dwLevel,
                             (LPBYTE *)&pBuf);
   //
   // If the call is successful,
   //  print the workstation data.
   //
   if (nStatus == NERR_Success)
   {
      printf("\n\tPlatform: %d\n", pBuf->wki102_platform_id);
      wprintf(L"\tName:     %s\n", pBuf->wki102_computername);
      printf("\tVersion:  %d.%d\n", pBuf->wki102_ver_major,
                                  pBuf->wki102_ver_minor);
      wprintf(L"\tDomain:   %s\n", pBuf->wki102_langroup);
      wprintf(L"\tLan Root: %s\n", pBuf->wki102_lanroot);
      wprintf(L"\t# Logged On Users: %d\n", pBuf->wki102_logged_on_users);
   }
   //
   // Otherwise, indicate the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated memory.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

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

各言語での呼び出し定義

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

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

NetWkstaGetInfo = ctypes.windll.netapi32.NetWkstaGetInfo
NetWkstaGetInfo.restype = wintypes.DWORD
NetWkstaGetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetWkstaGetInfo = netapi32.NewProc("NetWkstaGetInfo")
)

// servername (LPWSTR optional), level (DWORD), bufptr (BYTE** optional, out)
r1, _, err := procNetWkstaGetInfo.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
	uintptr(level),
	uintptr(bufptr),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetWkstaGetInfo(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE** optional, out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetWkstaGetInfo';
result := DllCall("NETAPI32\NetWkstaGetInfo"
    , "WStr", servername   ; LPWSTR optional
    , "UInt", level   ; DWORD
    , "Ptr", bufptr   ; BYTE** optional, out
    , "UInt")   ; return: DWORD
●NetWkstaGetInfo(servername, level, bufptr) = DLL("NETAPI32.dll", "dword NetWkstaGetInfo(char*, dword, void*)")
# 呼び出し: NetWkstaGetInfo(servername, level, bufptr)
# servername : LPWSTR optional -> "char*"
# level : DWORD -> "dword"
# bufptr : BYTE** optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef NetWkstaGetInfoNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef NetWkstaGetInfoDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>);
final NetWkstaGetInfo = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetWkstaGetInfoNative, NetWkstaGetInfoDart>('NetWkstaGetInfo');
// servername : LPWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE** optional, out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetWkstaGetInfo(
  servername: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE** optional, out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetWkstaGetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetWkstaGetInfo"
  c_NetWkstaGetInfo :: CWString -> Word32 -> Ptr Word8 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- level : DWORD -> Word32
-- bufptr : BYTE** optional, out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netwkstagetinfo =
  foreign "NetWkstaGetInfo"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : BYTE** optional, out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetWkstaGetInfo" net-wksta-get-info :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (level :uint32)   ; DWORD
  (bufptr :pointer))   ; BYTE** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetWkstaGetInfo = Win32::API::More->new('NETAPI32',
    'DWORD NetWkstaGetInfo(LPCWSTR servername, DWORD level, LPVOID bufptr)');
# my $ret = $NetWkstaGetInfo->Call($servername, $level, $bufptr);
# servername : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目