NetSessionEnum
The NetSessionEnum
function provides information about all current sessions.
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.
See Also