Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

NetWkstaUserEnum (netapi32)
 
.
Summary
The NetWkstaUserEnum function lists information about all users currently logged on to the workstation. This list includes interactive, service and batch logons.

C# Signature:

    [DllImport("netapi32.dll", CharSet = CharSet.Unicode, SetLastError=true)]
    static extern int NetWkstaUserEnum(
       string servername,
       int level,
       out IntPtr bufptr,
       int prefmaxlen,
       out int entriesread,
       out int totalentries,
       ref int resume_handle);

VB Signature:

Declare Function NetWkstaUserEnum Lib "netapi32.dll" (TODO) As TODO

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

If you want to find the user logged in to the workstation, you consider instead a WMI query ("select UserName from Win32_ComputerSystem"), which has certain advantages (runs faster, less ambigious results, doesn't require Interop if using .Net 2.0 System.Management namespace, etc.)

Tips & Tricks:

Please add some!

Sample Code:

class NetWorkstationUserEnum

{

    [DllImport("netapi32.dll", CharSet = CharSet.Unicode, SetLastError=true)]
    static extern int NetWkstaUserEnum(
       string servername,
       int level,
       out IntPtr bufptr,
       int prefmaxlen,
       out int entriesread,
       out int totalentries,
       ref int resume_handle);

    [DllImport("netapi32.dll")]
    static extern int NetApiBufferFree(
       IntPtr Buffer);

    const int NERR_SUCCESS = 0;
    const int ERROR_MORE_DATA = 234;

    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
    public struct WKSTA_USER_INFO_0
    {
        public string wkui0_username;
    }

    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
    public struct WKSTA_USER_INFO_1
    {
        public string wkui1_username;
        public string wkui1_logon_domain;
        public string wkui1_oth_domains;
        public string wkui1_logon_server;
    }
    void ScanHost(string hostName)
    {

        IntPtr bufptr = IntPtr.Zero;
        int dwEntriesread;
        int dwTotalentries = 0;
        int dwResumehandle = 0;
        int nStatus;
        Type tWui1 = typeof(WKSTA_USER_INFO_1);
        int nStructSize = Marshal.SizeOf(tWui1);
        WKSTA_USER_INFO_1 wui1;

        //this.listView1.Items.Clear();

        do
        {
        nStatus = NetWkstaUserEnum(
          hostName,
1,           out bufptr,
          32768,
          out dwEntriesread,
          out dwTotalentries,
          ref dwResumehandle);

        //
        // If the call succeeds,
        //
        if ((nStatus == NERR_SUCCESS) | (nStatus == ERROR_MORE_DATA))
        {
            if (dwEntriesread > 0)
            {
            IntPtr pstruct = bufptr;

            //
            // Loop through the entries.
            //
            for (int i = 0; i < dwEntriesread; i++)
            {
                wui1 = (WKSTA_USER_INFO_1)Marshal.PtrToStructure(pstruct, tWui1);
                Console.WriteLine(wui1.wkui1_logon_domain + "\\" + wui1.wkui1_username);
                pstruct = (IntPtr)((int)pstruct + nStructSize);
            }
            }
            else
            {
            Console.WriteLine("A system error has occurred : " + nStatus);
            }
        }

        if (bufptr != IntPtr.Zero)
            NetApiBufferFree(bufptr);

        } while (nStatus == ERROR_MORE_DATA);
    }
    static public void Main(string[] args)
    {
        string host = Environment.MachineName;
        if (args.Length > 0)
        {
        host = args[0];
        }
        NetWorkstationUserEnum nws = new NetWorkstationUserEnum();
        nws.ScanHost(host);
    }

}

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Find References
Show Printable Version
Revisions