NetSessionEnum info  Overview  Group

The NetSessionEnum function provides information about all current sessions.

Windows 95:
This function is exported by SVRAPI.DLL. Therefore, link your application with SVRAPI.LIB.

Security Requirements

Only members of the Administrators or Account Operators local group can successfully execute NetSessionEnum at level 1 or level 2. No special group membership is required for level 0 or level 10 calls.

NET_API_STATUS NetSessionEnum(

LPTSTR servername,
LPTSTR UncClientName,
LPTSTR username,
DWORD level,
LPBYTE *bufptr,
DWORD prefmaxlen,
LPDWORD entriesread,
LPDWORD totalentries,
LPDWORD resume_handle
);

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.

UncClientName

Pointer to a Unicode string containing the name of the computer session for which information is to be returned. A NULL pointer or string specifies that all computer sessions on the server are to be enumerated.

username

Pointer to a Unicode string containing the name of the the user for which to enumerate the sessions. A NULL pointer or string specifies that sessions for all users are to be enumerated.

level

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

Value	Meaning
0	The bufptr parameter points to an array of SESSION_INFO_0 structures.
1	The bufptr parameter points to an array of SESSION_INFO_1 structures.
2	The bufptr parameter points to an array of SESSION_INFO_2 structures.
10	The bufptr parameter points to an array of SESSION_INFO_10 structures.
502	The bufptr parameter points to an array of SESSION_INFO_502 structures.

bufptr

Pointer to the buffer in which the data set with the level parameter is stored.

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.

resume_handle

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

Return Values

If the function returns account information, the return value is NERR_Success.

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

Value	Meaning
ERROR_ACCESS_DENIED	The user does not have access to the requested information.
ERROR_INVALID_LEVEL	The value specified for the Level parameter is invalid.
ERROR_INVALID_PARAMETER	The specified parameter is invalid.
ERROR_NOT_ENOUGH_MEMORY	Insufficient memory is available.
NERR_ClientNameNotFound	The specified computer does not have a session with the computer.
NERR_InvalidComputer	The computer name is invalid.
NERR_UserNotFound	The user name could not be found.

See Also

NetSessionGetInfo, SESSION_INFO_0, SESSION_INFO_1, SESSION_INFO_2, SESSION_INFO_10, SESSION_INFO_502