ホーム › NetworkManagement.NetManagement › NetWkstaUserGetInfo

NetWkstaUserGetInfo

関数

現在ログオン中のユーザーのワークステーション情報を取得する。

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

シグネチャ

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

DWORD NetWkstaUserGetInfo(
    LPWSTR reserved,   // optional
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前

型

方向

説明

reserved

LPWSTR

inoptional

このパラメーターは NULL に設定する必要があります。

level

DWORD

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

値	意味
0	ワークステーションに現在ログオンしているユーザーの名前を返します。bufptr パラメーターは WKSTA_USER_INFO_0 構造体を指します。
1	現在のユーザー名やワークステーションがアクセスしたドメインなど、ワークステーションに関する情報を返します。bufptr パラメーターは WKSTA_USER_INFO_1 構造体を指します。
1101	ワークステーションがブラウズしたドメインを返します。bufptr パラメーターは WKSTA_USER_INFO_1101 構造体を指します。

bufptr

BYTE**

out

データを受け取るバッファーへのポインター。このデータの形式は bufptr パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetWkstaUserGetInfo 関数は、現在ログオンしているユーザーに関する情報を返します。この関数は、ログオン中のユーザーのコンテキストで呼び出す必要があります。

戻り値

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

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

戻り値コード	説明
ERROR_NOT_ENOUGH_MEMORY	システムのメモリリソースが不足しました。ネットワークマネージャーの構成が正しくないか、メモリが不足しているシステムでプログラムが実行されています。
ERROR_INVALID_LEVEL	level パラメーターが無効です。
ERROR_INVALID_PARAMETER	関数パラメーターのいずれかが無効です。

解説(Remarks)

NetWkstaUserGetInfo 関数はローカルでのみ動作します。

例

次のコードサンプルは、NetWkstaUserGetInfo 関数の呼び出しを使用して、現在ログオンしているユーザーに関する情報を取得する方法を示しています。このサンプルは、情報レベル 1 ( WKSTA_USER_INFO_1) を指定して NetWkstaUserGetInfo を呼び出します。呼び出しが成功した場合、サンプルはログオンしているユーザーに関する情報を出力します。最後に、サンプルは情報バッファー用に割り当てられたメモリを解放します。

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

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

int wmain(void)
{
   DWORD dwLevel = 1;
   LPWKSTA_USER_INFO_1 pBuf = NULL;
   NET_API_STATUS nStatus;
   //
   // Call the NetWkstaUserGetInfo function;
   //  specify level 1.
   //
   nStatus = NetWkstaUserGetInfo(NULL,
                                 dwLevel,
                                 (LPBYTE *)&pBuf);
   //
   // If the call succeeds, print the information
   //  about the logged-on user.
   //
   if (nStatus == NERR_Success)
   {
      if (pBuf != NULL)
      {
         wprintf(L"\n\tUser:          %s\n", pBuf->wkui1_username);
         wprintf(L"\tDomain:        %s\n", pBuf->wkui1_logon_domain);
         wprintf(L"\tOther Domains: %s\n", pBuf->wkui1_oth_domains);
         wprintf(L"\tLogon Server:  %s\n", pBuf->wkui1_logon_server);
      }
   }
   // Otherwise, print 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 NetWkstaUserGetInfo(
    LPWSTR reserved,   // optional
    DWORD level,
    BYTE** bufptr
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetWkstaUserGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string reserved,   // LPWSTR optional
    uint level,   // DWORD
    IntPtr bufptr   // BYTE** out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetWkstaUserGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> reserved As String,   ' LPWSTR optional
    level As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE** out
) As UInteger
End Function

' reserved : LPWSTR optional
' level : DWORD
' bufptr : BYTE** out
Declare PtrSafe Function NetWkstaUserGetInfo Lib "netapi32" ( _
    ByVal reserved 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

NetWkstaUserGetInfo = ctypes.windll.netapi32.NetWkstaUserGetInfo
NetWkstaUserGetInfo.restype = wintypes.DWORD
NetWkstaUserGetInfo.argtypes = [
    wintypes.LPCWSTR,  # reserved : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetWkstaUserGetInfo = Fiddle::Function.new(
  lib['NetWkstaUserGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # reserved : LPWSTR optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetWkstaUserGetInfo(
        reserved: *mut u16,  // LPWSTR optional
        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 NetWkstaUserGetInfo([MarshalAs(UnmanagedType.LPWStr)] string reserved, uint level, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetWkstaUserGetInfo' -Namespace Win32 -PassThru
# $api::NetWkstaUserGetInfo(reserved, level, bufptr)

#uselib "NETAPI32.dll"
#func global NetWkstaUserGetInfo "NetWkstaUserGetInfo" sptr, sptr, sptr
; NetWkstaUserGetInfo reserved, level, varptr(bufptr)   ; 戻り値は stat
; reserved : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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