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

NetSessionGetInfo

関数
指定したネットワークセッションの情報を取得する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetSessionGetInfo(
    LPWSTR servername,   // optional
    LPWSTR UncClientName,
    LPWSTR username,
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前方向説明
servernameLPWSTRinoptional関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
UncClientNameLPWSTRin情報を返す対象となるコンピューターセッションの名前を指定する文字列へのポインター。このパラメーターは必須であり、NULL にはできません。詳細については、 NetSessionEnum を参照してください。
usernameLPWSTRinセッション情報を返す対象となるユーザーの名前を指定する文字列へのポインター。このパラメーターは必須であり、NULL にはできません。
levelDWORDin

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

意味
0
セッションを確立したコンピューターの名前を返します。

bufptr パラメーターは SESSION_INFO_0 構造体を指します。

1
コンピューターの名前、ユーザーの名前、およびコンピューター上で開いているファイル、パイプ、デバイスを返します。

bufptr パラメーターは SESSION_INFO_1 構造体を指します。

2
レベル 1 で示される情報に加えて、クライアントの種類とユーザーがセッションを確立した方法を返します。

bufptr パラメーターは SESSION_INFO_2 構造体を指します。

10
コンピューターの名前、ユーザーの名前、およびセッションのアクティブ時間とアイドル時間を返します。

bufptr パラメーターは SESSION_INFO_10 構造体を指します。

bufptrBYTE**out

データを受け取るバッファーへのポインター。このデータの形式は level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。

戻り値の型: DWORD

公式ドキュメント

特定のサーバーとワークステーションの間に確立されたセッションに関する情報を取得します。

戻り値

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

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

戻り値コード 説明
ERROR_ACCESS_DENIED
ユーザーが要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL
level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER
指定されたパラメーターが無効です。
ERROR_NOT_ENOUGH_MEMORY
利用可能なメモリが不足しています。
NERR_ClientNameNotFound
指定されたコンピューター名とのセッションが存在しません。
NERR_InvalidComputer
コンピューター名が無効です。
NERR_UserNotFound
ユーザー名が見つかりませんでした。

解説(Remarks)

NetSessionGetInfo 関数をレベル 1 またはレベル 2 で正常に実行できるのは、Administrators または Server Operators ローカルグループのメンバーのみです。レベル 0 またはレベル 10 の呼び出しには、特別なグループメンバーシップは不要です。

Active Directory 向けにプログラミングしている場合は、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで、ネットワーク管理セッション関数を呼び出して実現できる機能と同じ機能を実現できることがあります。詳細については、 IADsSession および IADsFileServiceOperations を参照してください。

メンバーサーバーまたはワークステーション上でこの関数を情報レベル 1 または 2 で呼び出した場合、認証済みのすべてのユーザーがその情報を参照できます。

次のコードサンプルは、 NetSessionGetInfo 関数の呼び出しによってセッションに関する情報を取得する方法を示します。このサンプルでは、情報レベル 10 ( SESSION_INFO_10) を指定して NetSessionGetInfo を呼び出します。呼び出しが成功すると、コードはセッションに関する情報を出力します。最後に、サンプルは情報バッファー用に割り当てられたメモリを解放します。

#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 = 10;
   LPSESSION_INFO_10 pBuf = NULL;
   LPTSTR pszServerName = NULL;
   LPTSTR pszUNCClientName = NULL;
   LPTSTR pszUserName = NULL;
   NET_API_STATUS nStatus;
   //
   // Check command line arguments.
   //
   if (argc == 3)
   {
      pszUNCClientName = argv[1];
      pszUserName = argv[2];
   }
   else if (argc == 4)
   {
      pszServerName = argv[1];
      pszUNCClientName = argv[2];
      pszUserName = argv[3];
   }
   else
   {
      wprintf(L"Usage: %s [\\\\ServerName] \\\\ClientName UserName\n", argv[0]);
      exit(1);
   }
   //
   // Call the NetSessionGetInfo function, specifying level 10.
   //
   nStatus = NetSessionGetInfo(pszServerName,
                               pszUNCClientName,
                               pszUserName,
                               dwLevel,
                               (LPBYTE *)&pBuf);
   //
   // If the call succeeds,
   //
   if (nStatus == NERR_Success)
   {
      if (pBuf != NULL)
      {
         //
         // Print the session information. 
         //
         wprintf(L"\n\tClient: %s\n", pBuf->sesi10_cname);
         wprintf(L"\tUser:   %s\n", pBuf->sesi10_username);
         printf("\tActive: %d\n", pBuf->sesi10_time);
         printf("\tIdle:   %d\n", pBuf->sesi10_idle_time);
      }
   }
   //
   // Otherwise, indicate a 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 NetSessionGetInfo(
    LPWSTR servername,   // optional
    LPWSTR UncClientName,
    LPWSTR username,
    DWORD level,
    BYTE** bufptr
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetSessionGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string UncClientName,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string username,   // LPWSTR
    uint level,   // DWORD
    IntPtr bufptr   // BYTE** out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetSessionGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> UncClientName As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> username As String,   ' LPWSTR
    level As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE** out
) As UInteger
End Function
' servername : LPWSTR optional
' UncClientName : LPWSTR
' username : LPWSTR
' level : DWORD
' bufptr : BYTE** out
Declare PtrSafe Function NetSessionGetInfo Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal UncClientName As LongPtr, _
    ByVal username 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

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

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetSessionGetInfo = netapi32.NewProc("NetSessionGetInfo")
)

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

extern "netapi32" fn NetSessionGetInfo(
    servername: [*c]const u16, // LPWSTR optional
    UncClientName: [*c]const u16, // LPWSTR
    username: [*c]const u16, // LPWSTR
    level: u32, // DWORD
    bufptr: [*c][*c]u8 // BYTE** out
) callconv(std.os.windows.WINAPI) u32;
proc NetSessionGetInfo(
    servername: WideCString,  # LPWSTR optional
    UncClientName: WideCString,  # LPWSTR
    username: WideCString,  # LPWSTR
    level: uint32,  # DWORD
    bufptr: ptr uint8  # BYTE** out
): uint32 {.importc: "NetSessionGetInfo", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetSessionGetInfo(
    const(wchar)* servername,   // LPWSTR optional
    const(wchar)* UncClientName,   // LPWSTR
    const(wchar)* username,   // LPWSTR
    uint level,   // DWORD
    ubyte** bufptr   // BYTE** out
);
ccall((:NetSessionGetInfo, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Cwstring, UInt32, Ptr{UInt8}),
      servername, UncClientName, username, level, bufptr)
# servername : LPWSTR optional -> Cwstring
# UncClientName : LPWSTR -> Cwstring
# username : LPWSTR -> Cwstring
# level : DWORD -> UInt32
# bufptr : BYTE** out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetSessionGetInfo(
    const uint16_t* servername,
    const uint16_t* UncClientName,
    const uint16_t* username,
    uint32_t level,
    uint8_t** bufptr);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetSessionGetInfo(servername, UncClientName, username, level, bufptr)
-- servername : LPWSTR optional
-- UncClientName : LPWSTR
-- username : LPWSTR
-- level : DWORD
-- bufptr : BYTE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetSessionGetInfo = lib.func('__stdcall', 'NetSessionGetInfo', 'uint32_t', ['str16', 'str16', 'str16', 'uint32_t', 'uint8_t *']);
// NetSessionGetInfo(servername, UncClientName, username, level, bufptr)
// servername : LPWSTR optional -> 'str16'
// UncClientName : LPWSTR -> 'str16'
// username : LPWSTR -> 'str16'
// level : DWORD -> 'uint32_t'
// bufptr : BYTE** out -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetSessionGetInfo: { parameters: ["buffer", "buffer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.NetSessionGetInfo(servername, UncClientName, username, level, bufptr)
// servername : LPWSTR optional -> "buffer"
// UncClientName : LPWSTR -> "buffer"
// username : LPWSTR -> "buffer"
// level : DWORD -> "u32"
// bufptr : BYTE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetSessionGetInfo(
    const uint16_t* servername,
    const uint16_t* UncClientName,
    const uint16_t* username,
    uint32_t level,
    uint8_t** bufptr);
C, "NETAPI32.dll");
// $ffi->NetSessionGetInfo(servername, UncClientName, username, level, bufptr);
// servername : LPWSTR optional
// UncClientName : LPWSTR
// username : LPWSTR
// level : DWORD
// bufptr : 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 NetSessionGetInfo(
        WString servername,   // LPWSTR optional
        WString UncClientName,   // LPWSTR
        WString username,   // LPWSTR
        int level,   // DWORD
        Pointer bufptr   // BYTE** out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetSessionGetInfo = NetSessionGetInfo(
    servername : UInt16*,   # LPWSTR optional
    UncClientName : UInt16*,   # LPWSTR
    username : UInt16*,   # LPWSTR
    level : UInt32,   # DWORD
    bufptr : 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 NetSessionGetInfoNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef NetSessionGetInfoDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Uint8>);
final NetSessionGetInfo = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetSessionGetInfoNative, NetSessionGetInfoDart>('NetSessionGetInfo');
// servername : LPWSTR optional -> Pointer<Utf16>
// UncClientName : LPWSTR -> Pointer<Utf16>
// username : LPWSTR -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetSessionGetInfo(
  servername: PWideChar;   // LPWSTR optional
  UncClientName: PWideChar;   // LPWSTR
  username: PWideChar;   // LPWSTR
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetSessionGetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let netsessiongetinfo =
  foreign "NetSessionGetInfo"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* UncClientName : LPWSTR -> (ptr uint16_t) *)
(* username : LPWSTR -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : 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 ("NetSessionGetInfo" net-session-get-info :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (unc-client-name (:string :encoding :utf-16le))   ; LPWSTR
  (username (:string :encoding :utf-16le))   ; LPWSTR
  (level :uint32)   ; DWORD
  (bufptr :pointer))   ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetSessionGetInfo = Win32::API::More->new('NETAPI32',
    'DWORD NetSessionGetInfo(LPCWSTR servername, LPCWSTR UncClientName, LPCWSTR username, DWORD level, LPVOID bufptr)');
# my $ret = $NetSessionGetInfo->Call($servername, $UncClientName, $username, $level, $bufptr);
# servername : LPWSTR optional -> LPCWSTR
# UncClientName : LPWSTR -> LPCWSTR
# username : LPWSTR -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目