This section lists the parameters commonly used in this book. Exceptions are described where they occur. Unless stated otherwise, all ASCIIZ strings mentioned in the following list conform to the naming conventions in Naming Conventions.

Tip:

Copy this section (or print it if you are viewing the online version) and the table of contents or index to use alongside the APIs described later in this book.

buf

(unsigned char LSFAR *) points to the local buffer address of the data structure to be sent or received with an API call.
pStatusbuf
(unsigned char LSFAR *) points to a buffer of size lsdce_err_stat_t (defined in lsdceerr.h). The pStatusbuf contains specific DCE error information when NERR_DCEError is returned. It must be NULL for LAN Server and Warp Server requests.
pszDirPath
(unsigned char LSFAR *) points to an ASCIIZ string containing the name of the directory upon which the API is to act. The ASCIIZ name is in the form of a complete directory path, beginning with the drive letter and ending without a backslash (for example, C:\IBMLAN\LOGS). The only exception is a root directory, which ends with a backslash (for example, C:\).
pszGroupID
(unsigned char LSFAR *) points to an ASCIIZ string containing the group ID upon which the API is to act.
pszQueueName
(unsigned char LSFAR *) points to an ASCIIZ string containing the name of a particular printer queue.
pszReservedX
(unsigned char LSFAR *) is an extra parameter. Presently, it is reserved and must be NULL.
pszResource
(unsigned char LSFAR *) points to an ASCIIZ string containing the name of the local resource: ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿³RESOURCETYPE ³ASCIIZSTRINGFORMAT ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ Drive ³ driveletter: ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ Directory ³ driveletter:\directorypath ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ File ³ driveletter:\directorypath\ ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ Named Pipe ³ \PIPE\pipename ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ Spooler queue ³ \PRINT\queuename ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³ Serial device queue ³ \COMM\chardevqueue ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ

pszServername
(const unsigned char LSFAR *) points to an ASCIIZ string containing the network name of the server that is to run the API call. Server names begin with a double backslash (\\servername). A NULL pointer or string indicates that the API is to be invoked on the local computer.
pszUserID
(unsigned char LSFAR *) points to an ASCIIZ string containing a particular user ID.
pusBytesAvail or pulBytesAvail
(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to the number of bytes currently available from an API. (Sometimes this parameter is used with reiterative calls when pusBytesReturned does not include all of the available data; in this case, you can use pusBytesAvail to determine the next usBuflen size or the number of reiterations required to return all of the available data.)
pusBytesReturned or pulBytesReturned
(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to the number of bytes returned from an API to the buf data structure. (Since this is the actual size of the returned data structure, this number always is less than or equal to usBuflen.)
pusEntriesAvail or pulEntriesAvail
(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to the number of data structures currently available from an API. (Sometimes this parameter is used with reiterative calls when pusEntriesReturned does not include all of the available entries; in that case, you can use pusEntriesAvail to determine the next usBuflen size or the number of reiterations required to return all of the available data.)
pusEntriesReturned or pulEntriesReturned
(16-bit unsigned short LSFAR * or 32-bit unsigned long LSFAR *) points to the number of data structures returned from an API. (For example, in retrieving the same information about all users logged on to a particular server, a sequential list of data structures can be returned, one for each user.)
sIncludeSubdirs
(16-bit short or 32-bit unsigned long) sometimes is used with the pszDirPath parameter for XXXEnum and XXXCheck APIs to specify whether the API is to act upon all of the subdirectories under the pszDirPath tree. If the value of this parameter is 0, only the specified pszDirPath is acted upon. If the value is nonzero, all subdirectories under pszDirPath are included.
sLevel or ulLevel
(16-bit short or 32-bit unsigned long) specifies which level of a data structure to use, where each level contains a unique set of information fields. (The levels of a data structure often are arranged in a hierarchy in which each level contains the data of its preceding level plus additional data fields.)
usBuflen or ulBuflen
(16-bit unsigned short or 32-bit unsigned long) specifies the amount of local memory (in bytes) allocated to the buf data structure.
usJobId
(unsigned short) specifies the identification number for a particular print job.

---

[Back] [Next]