NetWkstaUserEnum

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

Security Requirements

Only members of the Administrators local group can successfully execute NetWkstaUserEnum both locally and on a remote server.

NET_API_STATUS NetWkstaUserEnum(
  LPWSTR servername,    
  DWORD level,          
  LPBYTE *bufptr,       
  DWORD prefmaxlen,     
  LPDWORD entriesread,  
  LPDWORD totalentries, 
  LPDWORD resumehandle  
);
 

Parameters

servername

Pointer to a Unicode string containing the name of the remote server on which the function is to execute. A NULL pointer or string specifies the local computer.

level

Specifies one of the following values to return the level of information provided.

Value	Meaning
0	The bufptr parameter points to a WKSTA_USER_INFO_0 structure.
1	The bufptr parameter points to a WKSTA_USER_INFO_1 structure.

bufptr

On return, a pointer to the return information structure is returned in the address pointed to by bufptr.

prefmaxlen

Preferred maximum length, in 8-bit bytes of returned data.

entriesread

Pointer to a DWORD that contains the actual enumerated element count.

totalentries

Pointer to a DWORD that contains the total number of entries that could have been enumerated from the current resume position.

resumehandle

Pointer to a DWORD that contains resumehandle, whhich is used to continue an existing search. The handle should be zero on the first call and left unchanged for subsequent calls. If resumehandle is NULL, no resume handle is stored.

Return Values

If the function is successful, it returns NERR_SUCCESS.

If the function fails, the return value is one of the following error codes.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in lmwksta.h.
  Import Library: Use netapi32.lib.

See Also

Networking (Net) Overview, Net Functions, NetWkstaGetInfo, NetWkstaSetInfo