SplEnumQueue - Parameters

pszComputerName (PSZ) - input

Name of computer where queues are to be listed.

A NULL string specifies the local workstation.

ulLevel (ULONG) - input

Level of detail.

The level of detail required. This must be 3, 4, 5, 6 or 7.

pBuf (PVOID) - output

Buffer.

The returned contents in the buffer depend on the value specified in ulLevel as follows:

ulLevel

Buffer Contents
3
An array of PRQINFO3 structures. The fsType bit PRQ3_TYPE_APPDEFAULT is set for the application default queue only.
4
An array of *pcReturned PRQINFO3 structures in which each PRQINFO3 structure is followed by an array of PRJINFO2 structures, one for each job in the queue. cJobs in the PRQINFO3 structure gives the number of jobs in the array.
5
An array of PSZ, each pointing to a queue name.
6
An array of PRQINFO6 structures
7
An array of pcReturned PRQINFO3 structures in which each PRQINFO3 structure is followed by an array of PRJINFO4 structures, one for each job in the queue. cJobs in the PRQINFO3 structure gives the number of jobs in the array.

cbBuf (ULONG) - input

Size, in bytes, of Buffer.

It must be greater than 0. Some systems do not allow a size greater than 65535.

pcReturned (PULONG) - output

Number of entries returned.

pcTotal (PULONG) - output

Total number of entries available.

pcbNeeded (PULONG) - output

Size in bytes of available information.

A value of 0 specifies that the size is not known. This can occur when enumerating queues on a print server. To determine the buffer size needed, the caller should allocate a buffer in 4096-byte increments until a successful return code is received, or until the buffer size exceeds 65535.

pReserved (PVOID) - output

Reserved value, must be NULL.

rc (SPLERR) - returns

Return code.

NO_ERROR (0)

No errors occurred.
ERROR_ACCESS_DENIED (5)
Access is denied.
ERROR_NOT_SUPPORTED (50)
This request is not supported by the network.
ERROR_BAD_NETPATH (53)
The network path cannot be located.
ERROR_INVALID_PARAMETER (87)
An invalid parameter is specified.
ERROR_INVALID_LEVEL (124)
The level parameter is invalid.
ERROR_MORE_DATA (234)
Additional data is available.
NERR_NetNotStarted (2102)
The network program is not started.
NERR_BufTooSmall (2123)
The API return buffer is too small.
NERR_InvalidComputer (2351)
The computer name is invalid.

---

[Back: SplEnumQueue Return Value - rc]
[Next: SplEnumQueue - Related Functions]