2.2.4.1.3.23 GetAgentCaps

The GetAgentCaps packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet obtains the agent-related capabilities that are supported on the specified line device. If a specific agent is named, the capabilities include a listing of ACD groups into which the agent is permitted to log in.


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

hLineApp

dwDeviceID

dwAddressID

dwAppAPIVersion

lpAgentCapsContext

lpAgentCapsSize

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

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 25.

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 positive request identifier if the asynchronous operation starts; otherwise, this function MUST return one of these negative error values:

Name

Value

LINEERR_BADDEVICEID

0x80000002

LINEERR_INCOMPATIBLEAPIVERSION

0x8000000C

LINEERR_INVALADDRESSID

0x80000011

LINEERR_INVALAPPHANDLE

0x80000014

LINEERR_INVALPOINTER

0x80000035

LINEERR_NODEVICE

0x80000042

LINEERR_NODRIVER

0x80000043

LINEERR_NOMEM

0x80000044

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_OPERATIONUNAVAIL

0x80000049

LINEERR_RESOURCEUNAVAIL

0x8000004B

LINEERR_STRUCTURETOOSMALL

0x8000004D

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.

hLineApp (4 bytes): An HLINEAPP. The handle to the registration of the application with TAPI. This field MUST have been obtained by sending the Initialize packet.

dwDeviceID (4 bytes): An unsigned 32-bit integer. The line device that contains the address to be queried.

dwAddressID (4 bytes): An unsigned 32-bit integer. The address on the specified line device whose capabilities are to be queried. An address identifier is permanently associated with an address; the identifier remains constant across operating system upgrades. A valid value of dwAddressID is in the range 0 to dwNumAddresses – 1. The client obtains dwNumAddresses from the LINEDEVCAPS obtained by sending a GetDevCaps packet to the remote server.

dwAppAPIVersion (4 bytes): An unsigned 32-bit integer. The highest TAPI version that is supported by the application. This SHOULD not be the value that is negotiated by using NegotiateAPIVersion on the device being queried.

lpAgentCapsContext (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.

lpAgentCapsSize (4 bytes): An unsigned 32-bit integer. The maximum size, in bytes, of agent capabilities data that the client accepts 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.