The NetCharDevEnum API provides information about all available serial devices pooled in shared serial device queues on a server.

Restrictions

This API can be called from DLS and OS/2 workstations, but DLS workstations can issue this call only to a remote LAN Server workstation. This API does not have any access authority requirements.

Syntax

#include <netcons.h>
#include <chardev.h>
 
NetCharDevEnum(pszServername, sLevel, buf,
               usBuflen, pusEntriesReturned, pusEntriesAvail);     /* 16 bit */
 
Net32CharDevEnum(pszServername, ulLevel, buf,
               ulBuflen, pulEntriesReturned, pulEntriesAvail);     /* 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 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_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. і
ГДДДДДДДДДДДДДДДДДДДДДДДДДДДДДЕДДДДДДДЕДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДДґ
і 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 listing serial device queues on a server, see Serial Device - NetCharDevQEnum.

---

[Back] [Next]