NetSessionGetInfo or Net32SessionGetInfo

The NetSessionGetInfo API retrieves information about a session established between a particular requester and server.

Restrictions

This API can be called from DLS and OS/2 workstations, but only DLS workstations can issue this call to a remote LAN Server workstation. Users with Server operator privilege can receive session information at level 0 or level 10. Administrator authority is required for full access.

Syntax

#include <netcons.h>
#include <shares.h>
 
NetSessionGetInfo(pszServername, pszWorkstation,
                  sLevel, buf, usBuflen,
                  pusBytesAvail);        /*  16 bit */
 
Net32SessionGetInfo(pszServername, pszWorkstation,
                  ulLevel, buf, ulBuflen,
                  pulBytesAvail);        /* 32 bit */

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

pszWorkstation

(const unsigned char LSFAR *) points to an ASCIIZ string containing the name of the requester whose session is to be monitored.
sLevel or ulLevel
(16-bit short or 32-bit unsigned long) specifies the level of detail (0, 1, 2, or 10) requested for the returned session_info data structure.
buf
(unsigned char LSFAR *) points to the session_info data structure.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌─────────────────────────────┬───────┬────────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE│MEANING │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_Success │ 0 │ No errors were encountered. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_ACCESS_DENIED │ 5 │ Administrator privilege is required. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_BAD_NETPATH │ 53 │ The network path cannot be found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NETWORK_ACCESS_DENIED │ 65 │ Network access is denied. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_LEVEL │ 124 │ The sLevel parameter is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_MORE_DATA │ 234 │ Additional data is available, but the │
│ │ │ buffer is too small. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_RemoteOnly │ 2106 │ This operation is not supported on │
│ │ │ workstations. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_ServerNotStarted │ 2114 │ The Server service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BufTooSmall │ 2123 │ The buffer is too small for fixed- │
│ │ │ length data. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InternalError │ 2140 │ An internal error has occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadTransactConfig │ 2141 │ The server is not configured for │
│ │ │ transactions. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_ClientNameNotFound │ 2312 │ A session does not exist with that │
│ │ │ computer name. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InvalidComputer │ 2351 │ The specified computer name is not │
│ │ │ valid. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosFsCtl
  
• DosGetShrSeg
Remarks

If you call this API with the buffer length parameter equal to zero, the API returns a value for total bytes available. This technique is useful if you do not know the exact buffer size required.

Related Information

For information about listing all sessions redirected to a resource, see Connection - NetConnectionEnum.

---

[Back: NetSessionEnum or Net32SessionEnum]
[Next: Share Category]