2.2.4.1.7.5 GetProviderList

The GetProviderList packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST return a list of service providers that are currently installed in the telephony system.

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

Return Values

On completion of ClientRequest, this field will contain 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. The remote server MUST complete this call synchronously.

MUST return zero if the request succeeds or a negative error number if an error occurs. Common return values are:

Name	Value
LINEERR_INCOMPATIBLEAPIVERSION	0x8000000C
LINEERR_NOMEM	0x80000044
LINEERR_INIFILECORRUPT	0x8000000E
LINEERR_OPERATIONFAILED	0x80000048
LINEERR_INVALPOINTER	0x80000035
LINEERR_STRUCTURETOOSMALL	0x8000004D

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

dwAPIVersion (4 bytes): An unsigned 32-bit integer. The highest version of TAPI that is supported by the application (not necessarily the value that is negotiated by the NegotiateAPIVersion packet on some particular line devices).

lpProviderList (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a LINEPROVIDERLIST packet that is filled with agent capabilities information, upon successful completion of the request. On successful completion, this field contains the offset, in bytes, of the packet in the VarData field.

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.

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

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

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

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

VarData (variable): On successful completion of the request, MUST contain a LINEPROVIDERLIST packet.