NetCharDevGetInfo or Net32CharDevGetInfo

The NetCharDevGetInfo API retrieves information about a particular serial device in a shared serial device queue on a server.

A device can belong to more than one queue.

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. This API does not have any access authority requirements.

Syntax

#include <netcons.h>
#include <chardev.h>
 
NetCharDevGetInfo(pszServername, devname, sLevel,
                    buf, usBuflen, pusBytesAvail);     /* 16 bit */
 
Net32CharDevGetInfo(pszServername, devname, ulLevel,
                    buf, ulBuflen, pulBytesAvail);     /* 32 bit */

Parameters

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

devname

(const unsigned char LSFAR *) points to an ASCIIZ string containing the name of the device.
sLevel or ulLevel
(16-bit short or 32-bit unsigned long) can be 0 or 1, specifying which data structure to use, as described in Serial Device Level 0 and Serial Device Level 1.
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_NOT_ENOUGH_MEMORY │ 8 │ Sufficient memory is not available. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_BAD_NETPATH │ 53 │ The network path cannot be found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NETWORK_ACCESS_DENIED │ 65 │ Network access is denied. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_LEVEL │ 124 │ The sLevel parameter is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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_OS2IoctlError │ 2134 │ An internal error occurred when │
│ │ │ calling the workstation driver. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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_DevNotFound │ 2332 │ This device cannot be shared. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoCommDevs │ 2337 │ There are no shared communication │
│ │ │ devices. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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 serial device queues, see Serial Device - NetCharDevEnum.

• Changing the state of a serial device, see Serial Device - NetCharDevControl.

---

[Back: NetCharDevEnum or Net32CharDevEnum]
[Next: NetCharDevQEnum or Net32CharDevQEnum]