2.2.4.1.3.39 GetProxyStatus

The GetProxyStatus packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet returns a list of proxy request types that are currently being serviced for the specified device.

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

Return Values

On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A value of 0 indicates success, and a LINEERR_Constants value indicates failure. The remote server MUST complete this call synchronously.

MUST return zero if the request succeeds; otherwise, the function MUST return one of the following negative error values:

Name	Value
LINEERR_BADDEVICEID	0x80000002
LINEERR_INCOMPATIBLEAPIVERSION	0x8000000C
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.

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

dwDeviceID (4 bytes): An unsigned 32-bit integer. The line device to query. A valid value of dwDeviceID is in the range 0 to dwNumDevs –1. The client obtains dwNumDevs by sending a Initialize packet to the remote server.

dwAppAPIVersion (4 bytes): An unsigned 32-bit integer. The version number of TAPI to be used. This value is obtained by sending the NegotiateAPIVersion packet.

lpLineProxyRequestList (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a LINEPROXYREQUESTLIST packet that contains a list of the currently supported proxy requests, 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.

VarData (variable): Contains a LINEPROXYREQUESTLIST packet.

The contents of this field MUST be DWORD-aligned, as specified in [MS-DTYP] section 2.2.9.