2.2.4.1.3.40 GetQueueInfo

The GetQueueInfo packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet returns a packet that holds the ACD information that is associated with a particular queue. It generates a LINE_PROXYREQUEST packet to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST packet of type LINEPROXYREQUEST_GETQUEUEINFO.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Req_Func

Reserved1

dwRequestID

lpContext

hLine

dwQueueID

lpQueueInfoContext

lpQueueInfo

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

Req_Func (4 bytes): An unsigned 32-bit integer. The identifier of the function that will be invoked on the remote server. This value MUST be set to 151.

Return Values

On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A nonzero request ID value indicates that the request is in progress and will complete asynchronously, and a LINEERR_Constants value indicates synchronous failure.

MUST return a request identifier if the asynchronous operation starts; otherwise, the function MUST return one of the following error values:

Name

Value

LINEERR_INVALLINEHANDLE

0x8000002B

LINEERR_INVALPARAM

0x80000032

LINEERR_NOMEM

0x80000044

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_OPERATIONUNAVAIL

0x80000049

LINEERR_RESOURCEUNAVAIL

0x8000004B

LINEERR_UNINITIALIZED

0x80000050

Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.

dwRequestID (4 bytes): An unsigned 32-bit integer. The identifier of the asynchronous request.

Value

Meaning

0x00000000

The server MUST generate a unique positive request ID to return as the Ack_ReturnValue.

0x00000001 — 0x7FFFFFFF

The server MUST use this value instead of generating a unique positive request ID.

lpContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.

hLine (4 bytes): An HLINE. The handle to the open line device. This field MUST have been obtained by sending the Open packet.

dwQueueID (4 bytes): An unsigned 32-bit integer. The identifier of the queue whose information is retrieved. This field MUST have been obtained from LINEQUEUEENTRY in LINEQUEUELIST. The LINEQUEUELIST MUST have been obtained by sending GetQueueList packet.

lpQueueInfoContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.

lpQueueInfo (4 bytes): An unsigned 32-bit integer. The maximum size, in bytes, of the queue information data that the client will accept on successful completion of this request.

Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved8 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.