NetCharDevQEnum or Net32CharDevQEnum

The NetCharDevQEnum API enumerates all serial device queues on a 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. This API does not have any access authority requirements.

Syntax

 
#include <netcons.h>
#include <chardev.h>
 
NetCharDevQEnum(pszServername, pszUserID, sLevel, buf,
                usBuflen, pusEntriesReturned, pusEntriesAvail);     /* 16 bit */
 
Net32CharDevQEnum(pszServername, pszUserID, ulLevel, buf,
                ulBuflen, pulEntriesReturned, pulEntriesAvail);     /* 32 bit */

Parameters

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

pszUserID

(const unsigned char LSFAR *) points to an ASCIIZ string containing a user name. To use pszUserID to calculate how many requests are pending ahead in the queue, examine the cq1_numahead field.
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 Queue Level 0 and Serial Device Queue 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_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_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_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 entries available. This technique is useful if you do not know the exact buffer size required.

Related Information

For information about:

• Deleting the contents of a serial device queue, see Serial Device - NetCharDevQPurge.

• Listing serial devices on a server, see Serial Device - NetCharDevEnum.

---

[Back: NetCharDevGetInfo or Net32CharDevGetInfo]
[Next: NetCharDevQGetInfo or Net32CharDevQGetInfo]