NetWkstaGetInfo or Net32WkstaGetInfo

The NetWkstaGetInfo API returns configuration information about a requester.

Restrictions

This API can be called from DOS and OS/2 workstations. This API requires that only remote users have administrator authority for the level 0, 1, and 2 data structures. The level 10 and 11 data structure, however, can be obtained with either administrator or user authority.

Note: Levels 2 and 11 are valid only for DSS.

Syntax

#include <netcons.h>
#include <wksta.h>
 
NetWkstaGetInfo(pszServername, sLevel, buf,
                usBuflen, pusBytesAvail);        /* 16 bit */
 
Net32WkstaGetInfo(pszServername, ulLevel, buf,
                ulBuflen, pulBytesAvail);      /* 32 bit */

Parameters

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

sLevel or ulLevel

(16-bit short or 32-bit unsigned long) can be 0, 1, 2, 10 or 11, specifying which data structure to use, as described in Requester Data Structures.
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_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadTransactConfig │ 2141 │ The server is not configured for │
│ │ │ transactions. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


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 changing the configuration of a local requester, see Requester - NetWkstaSetInfo.

---

[Back: Related Information]
[Next: NetWkstaSetInfo or Net32WkstaSetInfo]