NetCharDevQSetInfo or Net32CharDevQSetInfo

The NetCharDevQSetInfo API changes the state of a serial device queue on a server.

The NetCharDevQSetInfo can set the cq1_priority and the cq1_devs fields in the chardevQ_info_1 data structure.

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. Administrator authority is required to call this API.

Syntax

#include <netcons.h>
#include <chardev.h>
 
NetCharDevQSetInfo(pszServername, pszQueueName, sLevel,
                   buf, usBuflen, parmnum);     /* 16 bit */
 
Net32CharDevQSetInfo(pszServername, pszQueueName, ulLevel,
                     buf, ulBuflen, parmnum);     /* 32 bit */

Parameters

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

pszQueueName

(const unsigned char LSFAR *) points to an ASCIIZ string containing the name of a particular printer queue.
sLevel or ulLevel
(16-bit short or 32-bit unsigned long) must be 1, which specifies the data structure described in Serial Device Queue Level 1.
buf
(const unsigned char LSFAR *) points to the data structure described in Serial Device Queue Level 1.
parmnum
(16-bit short or 32-bit unsigned long) specifies whether the entire data structure or only a single field of the structure is to be passed. If the value is 0, the entire data structure is passed. Otherwise, parmnum can be set to pass only a single field, defined in CHARDEV.H as follows: ┌────────────────────────────────┬───────┬─────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ VALUE │ COMPONENT │
├────────────────────────────────┼───────┼─────────────────────────────────────┤
│ CHARDEVQ_PRIORITY_PARMNUM │ 2 │ cq1_priority │
├────────────────────────────────┼───────┼─────────────────────────────────────┤
│ CHARDEVQ_DEVICES_PARMNUM │ 3 │ cq1_devs │
└────────────────────────────────┴───────┴─────────────────────────────────────┘

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_SEM_TIMEOUT │ 121 │ A timeout happened from the semaphore │
│ │ │ API functions. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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_RedirectedPath │ 2117 │ The operation is not valid on a redi- │
│ │ │ rected device. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoRoom │ 2119 │ The server is currently out of the │
│ │ │ requested resource. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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_InvalidAPI │2142 │TherequestedAPIisnotsupportedon │
│ │ │ the remote server. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_UseNotFound │ 2250 │ The connection cannot be found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadQueuePriority │ 2335 │ The queue priority is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoCommDevs │ 2337 │ There are no shared communication │
│ │ │ devices. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_QueueNotFound │ 2338 │ A queue does not exist for this │
│ │ │ request. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadDevString │ 2340 │ This list of devices is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadDev │ 2341 │ The requested device is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InUseBySpooler │ 2342 │ This device is already in use by the │
│ │ │ spooler. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InvalidComputer │ 2351 │ The specified computer name is not │
│ │ │ valid. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosDevIOCtl
  
• DosFsRamSemRequest
  
• DosFsCtl
  
• DosGetShrSeg
  
• DosSemRequest
Related Information

For information about:

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

• Listing serial device queues on a server, see Serial Device - NetCharDevQEnum.

---

[Back: NetCharDevQPurgeSelf or Net32CharDevQPurgeSelf]
[Next: Server Category]