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

NetStatisticsGet

関数
ワークステーションまたはサーバーの稼働統計を取得する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetStatisticsGet(
    CHAR* ServerName,
    CHAR* Service,
    DWORD Level,
    DWORD Options,
    BYTE** Buffer
);

パラメーター

名前方向説明
ServerNameCHAR*in関数を実行するサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインターです。このパラメーターが NULL の場合は、ローカル コンピューターが使用されます。
ServiceCHAR*in統計を取得する対象のサービス名を指定する文字列へのポインターです。現在使用できる値は SERVICE_SERVERSERVICE_WORKSTATION のみです。
LevelDWORDin

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

意味
0
ワークステーションまたはサーバーに関する統計を返します。bufptr パラメーターは STAT_WORKSTATION_0 または STAT_SERVER_0 構造体を指します。
OptionsDWORDinこのパラメーターは 0 にする必要があります。
BufferBYTE**outデータを受け取るバッファーへのポインターです。このデータの形式は level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

サービスの動作統計を取得します。現在サポートされているのは、ワークステーション サービスとサーバー サービスのみです。

戻り値

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

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

解説(Remarks)

ワークステーションの統計を取得するために特別なグループ メンバーシップは必要ありません。リモート サーバー上で NetStatisticsGet 関数を正常に実行できるのは、Administrators または Server Operators ローカル グループのメンバーのみです。

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

各言語での呼び出し定義

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

DWORD NetStatisticsGet(
    CHAR* ServerName,
    CHAR* Service,
    DWORD Level,
    DWORD Options,
    BYTE** Buffer
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetStatisticsGet(
    IntPtr ServerName,   // CHAR*
    IntPtr Service,   // CHAR*
    uint Level,   // DWORD
    uint Options,   // DWORD
    IntPtr Buffer   // BYTE** out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetStatisticsGet(
    ServerName As IntPtr,   ' CHAR*
    Service As IntPtr,   ' CHAR*
    Level As UInteger,   ' DWORD
    Options As UInteger,   ' DWORD
    Buffer As IntPtr   ' BYTE** out
) As UInteger
End Function
' ServerName : CHAR*
' Service : CHAR*
' Level : DWORD
' Options : DWORD
' Buffer : BYTE** out
Declare PtrSafe Function NetStatisticsGet Lib "netapi32" ( _
    ByVal ServerName As LongPtr, _
    ByVal Service As LongPtr, _
    ByVal Level As Long, _
    ByVal Options As Long, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetStatisticsGet = ctypes.windll.netapi32.NetStatisticsGet
NetStatisticsGet.restype = wintypes.DWORD
NetStatisticsGet.argtypes = [
    ctypes.POINTER(ctypes.c_byte),  # ServerName : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # Service : CHAR*
    wintypes.DWORD,  # Level : DWORD
    wintypes.DWORD,  # Options : DWORD
    ctypes.c_void_p,  # Buffer : BYTE** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetStatisticsGet = Fiddle::Function.new(
  lib['NetStatisticsGet'],
  [
    Fiddle::TYPE_VOIDP,  # ServerName : CHAR*
    Fiddle::TYPE_VOIDP,  # Service : CHAR*
    -Fiddle::TYPE_INT,  # Level : DWORD
    -Fiddle::TYPE_INT,  # Options : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetStatisticsGet(
        ServerName: *mut i8,  // CHAR*
        Service: *mut i8,  // CHAR*
        Level: u32,  // DWORD
        Options: u32,  // DWORD
        Buffer: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetStatisticsGet(IntPtr ServerName, IntPtr Service, uint Level, uint Options, IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetStatisticsGet' -Namespace Win32 -PassThru
# $api::NetStatisticsGet(ServerName, Service, Level, Options, Buffer)
#uselib "NETAPI32.dll"
#func global NetStatisticsGet "NetStatisticsGet" sptr, sptr, sptr, sptr, sptr
; NetStatisticsGet varptr(ServerName), varptr(Service), Level, Options, varptr(Buffer)   ; 戻り値は stat
; ServerName : CHAR* -> "sptr"
; Service : CHAR* -> "sptr"
; Level : DWORD -> "sptr"
; Options : DWORD -> "sptr"
; Buffer : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetStatisticsGet "NetStatisticsGet" var, var, int, int, var
; res = NetStatisticsGet(ServerName, Service, Level, Options, Buffer)
; ServerName : CHAR* -> "var"
; Service : CHAR* -> "var"
; Level : DWORD -> "int"
; Options : DWORD -> "int"
; Buffer : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetStatisticsGet(CHAR* ServerName, CHAR* Service, DWORD Level, DWORD Options, BYTE** Buffer)
#uselib "NETAPI32.dll"
#cfunc global NetStatisticsGet "NetStatisticsGet" var, var, int, int, var
; res = NetStatisticsGet(ServerName, Service, Level, Options, Buffer)
; ServerName : CHAR* -> "var"
; Service : CHAR* -> "var"
; Level : DWORD -> "int"
; Options : DWORD -> "int"
; Buffer : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetStatisticsGet = netapi32.NewProc("NetStatisticsGet")
)

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

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

typedef NetStatisticsGetNative = Uint32 Function(Pointer<Int8>, Pointer<Int8>, Uint32, Uint32, Pointer<Uint8>);
typedef NetStatisticsGetDart = int Function(Pointer<Int8>, Pointer<Int8>, int, int, Pointer<Uint8>);
final NetStatisticsGet = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetStatisticsGetNative, NetStatisticsGetDart>('NetStatisticsGet');
// ServerName : CHAR* -> Pointer<Int8>
// Service : CHAR* -> Pointer<Int8>
// Level : DWORD -> Uint32
// Options : DWORD -> Uint32
// Buffer : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetStatisticsGet(
  ServerName: Pointer;   // CHAR*
  Service: Pointer;   // CHAR*
  Level: DWORD;   // DWORD
  Options: DWORD;   // DWORD
  Buffer: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetStatisticsGet';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetStatisticsGet"
  c_NetStatisticsGet :: Ptr Int8 -> Ptr Int8 -> Word32 -> Word32 -> Ptr Word8 -> IO Word32
-- ServerName : CHAR* -> Ptr Int8
-- Service : CHAR* -> Ptr Int8
-- Level : DWORD -> Word32
-- Options : DWORD -> Word32
-- Buffer : BYTE** out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netstatisticsget =
  foreign "NetStatisticsGet"
    ((ptr int8_t) @-> (ptr int8_t) @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* ServerName : CHAR* -> (ptr int8_t) *)
(* Service : CHAR* -> (ptr int8_t) *)
(* Level : DWORD -> uint32_t *)
(* Options : DWORD -> uint32_t *)
(* Buffer : BYTE** 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 ("NetStatisticsGet" net-statistics-get :convention :stdcall) :uint32
  (server-name :pointer)   ; CHAR*
  (service :pointer)   ; CHAR*
  (level :uint32)   ; DWORD
  (options :uint32)   ; DWORD
  (buffer :pointer))   ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetStatisticsGet = Win32::API::More->new('NETAPI32',
    'DWORD NetStatisticsGet(LPVOID ServerName, LPVOID Service, DWORD Level, DWORD Options, LPVOID Buffer)');
# my $ret = $NetStatisticsGet->Call($ServerName, $Service, $Level, $Options, $Buffer);
# ServerName : CHAR* -> LPVOID
# Service : CHAR* -> LPVOID
# Level : DWORD -> DWORD
# Options : DWORD -> DWORD
# Buffer : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目