NWPSCfgGetFirstPrintQueueAttr(3nw)

NWPSCfgGetFirstPrintQueueAttr -- finds first attribute for print queue and returns all values for attribute

Synopsis

   #include <nwps_cfg.h> 
   or 
   #include <nwpsrv.h> 
    
   NWCCODE NWAPI NWPSCfgGetFirstPrintQueueAttr 
     (WORD                    connType, 
      DWORD                   connID, 
      char NWFAR             queueName, 
      WORD                    attrID, 
      NWPSListHandle NWFAR    handle, 
      void NWFAR             attrValue);

Description

The parameters are as follows:

connType: (IN) Specifies either NWPS_BINDERY_SERVICE, NWPS_BINDERY_SERVICE_PRE_40, or NWPS_DIRECTORY_SERVICE.
connID: (IN) Specifies the connection or context identifier.
queueName: (IN) Points to the name of the queue.
attrID: (IN) Specifies the print services attribute identifier.
handle: (OUT) Points to the value to be passed to NWPSCfgGetNextPrintQueueAttr and NWPSCfgEndNextPrintQueueAttr(optional).
attrValue: (OUT) Points to the buffer in which to place the first attribute found. Its maximum length is MAX_DN_BYTES + sizeof(NWPSTypedName).

Return values

0x0000: Successful
0x7762: NWPSE_END_OF_ATTR_LIST
-1: General Error
other: Bindery or Directory Services Errors

Notices

NWPSCfgGetFirstPrintQueueAttr allocates memory and opens files that must be respectively deallocated and closed by calling NWPSCfgEndNextPrintQueueAttr. If the completion code is non-zero or if the attribute requested is single-valued, the value returned for the handle is zero. In this case, calling NWPSCfgEndNextPrintQueueAttr is not required.

The type of the buffer pointed to by attrValue depends on the value of attrID. If attrID is not recognized, an error is returned.

handle is optional. If it is NULL, NWPSCfgEndNextPrintQueueAttr is called by NWPSCfgGetFirstPrintQueueAttr to release any allocated resources. Normally calls to NWPSCfgGetFirstPrintQueueAttr for single-valued attributes should pass a NULL pointer to the handle. Calls to NWPSCfgGetFirstPrintQueueAttr for multi-valued attributes may also pass a NULL pointer if only the first value in the list is desired, or if the caller is trying only to determine the existence of elements in the list.

Legal attribute identifiers for the printer's queue follow:

Bindery Identifier Directory Identifier Type Multi Valued

None NWPS_ATTR_ACL Object_ACL_T Yes

NWPS_ATTR_CN NWPS_ATTR_CN char[ ] No

NWPS_ATTR_DESC NWPS_ATTR_DESC char[ ] No

NWPS_ATTR_DEVICE NWPS_ATTR_DEVICE char[ ] Yes

NWPS_ATTR_HOST_RES NWPS_ATTR_HOST_RES char[ ] No

NWPS_ATTR_HOST_SER NWPS_ATTR_HOST_SER char[ ] No

None NWPS_ATTR_NADD Net_Address_T Yes

NWPS_ATTR_OPER NWPS_ATTR_OPER char[ ] Yes

NWPS_ATTR_QUE_DIR NWPS_ATTR_QUE_DIR NWPS_Typed_Name Yes

None NWPS_ATTR_SEE_ALSO char[ ] Yes

NWPS_ATTR_SERVER NWPS_ATTR_SERVER char[ ] Yes

NWPS_ATTR_USER NWPS_ATTR_USER NWPS_Typed_Name Yes

NWPS_ATTR_VOLUME NWPS_ATTR_VOLUME char[ ] No

Bindery Identifier	Directory Identifier	Type	Multi Valued
None	NWPS_ATTR_ACL	Object_ACL_T	Yes
NWPS_ATTR_CN	NWPS_ATTR_CN	char[ ]	No
NWPS_ATTR_DESC	NWPS_ATTR_DESC	char[ ]	No
NWPS_ATTR_DEVICE	NWPS_ATTR_DEVICE	char[ ]	Yes
NWPS_ATTR_HOST_RES	NWPS_ATTR_HOST_RES	char[ ]	No
NWPS_ATTR_HOST_SER	NWPS_ATTR_HOST_SER	char[ ]	No
None	NWPS_ATTR_NADD	Net_Address_T	Yes
NWPS_ATTR_OPER	NWPS_ATTR_OPER	char[ ]	Yes
NWPS_ATTR_QUE_DIR	NWPS_ATTR_QUE_DIR	NWPS_Typed_Name	Yes
None	NWPS_ATTR_SEE_ALSO	char[ ]	Yes
NWPS_ATTR_SERVER	NWPS_ATTR_SERVER	char[ ]	Yes
NWPS_ATTR_USER	NWPS_ATTR_USER	NWPS_Typed_Name	Yes
NWPS_ATTR_VOLUME	NWPS_ATTR_VOLUME	char[ ]	No

 
 ---------------------------------------------------------------------------- 
| Bindery Identifier|  Directory Identifier|  Type           |  Multi Valued| 
|-------------------|----------------------|-----------------|--------------| 
| None              |  NWPS_ATTR_ACL       |  Object_ACL_T   |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_CN      |  NWPS_ATTR_CN        |  char[ ]        |  No          | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_DESC    |  NWPS_ATTR_DESC      |  char[ ]        |  No          | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_DEVICE  |  NWPS_ATTR_DEVICE    |  char[ ]        |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_HOST_RES|  NWPS_ATTR_HOST_RES  |  char[ ]        |  No          | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_HOST_SER|  NWPS_ATTR_HOST_SER  |  char[ ]        |  No          | 
|-------------------|----------------------|-----------------|--------------| 
| None              |  NWPS_ATTR_NADD      |  Net_Address_T  |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_OPER    |  NWPS_ATTR_OPER      |  char[ ]        |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_QUE_DIR |  NWPS_ATTR_QUE_DIR   |  NWPS_Typed_Name|  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| None              |  NWPS_ATTR_SEE_ALSO  |  char[ ]        |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_SERVER  |  NWPS_ATTR_SERVER    |  char[ ]        |  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_USER    |  NWPS_ATTR_USER      |  NWPS_Typed_Name|  Yes         | 
|-------------------|----------------------|-----------------|--------------| 
| NWPS_ATTR_VOLUME  |  NWPS_ATTR_VOLUME    |  char[ ]        |  No          | 
|-------------------|----------------------|-----------------|--------------|

char[ ] is a NULL-terminated ASCII string.

Services

Print Server

References

NWPSCfgEndNextPrintQueueAttr(3nw), NWPSCfgGetNextPrintQueueAttr(3nw)