2.2.4.1.6.10 GetStatus

The GetStatus packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST enable an application to query the specified open phone device for its overall status.

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
hPhone
lpPhoneStatus
Reserved2
Reserved3
Reserved4
Reserved5
Reserved6
Reserved7
Reserved8
Reserved9
Reserved10
Reserved11
Reserved12
Reserved13
VarData (variable)
...

Req_Func (4 bytes): The identifier of the function that will be invoked on the remote server. This value MUST be set to 103.

Return Values

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

Returns 0 if the request succeeds or a negative error number if an error occurs. The following table lists common return values.

Name	Value
PHONEERR_INVALPHONEHANDLE	0x00000013
PHONEERR_NOMEM	0x0000001A
PHONEERR_INVALPOINTER	0x00000015
PHONEERR_RESOURCEUNAVAIL	0x0000001F
PHONEERR_OPERATIONFAILED	0x0000001C
PHONEERR_STRUCTURETOOSMALL	0x00000021
PHONEERR_OPERATIONUNAVAIL	0x0000001D
PHONEERR_UNINITIALIZED	0x00000022

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

hPhone (4 bytes): An HPHONE. The handle to the open phone device to be queried. This field MUST have been obtained by sending the Open packet.

lpPhoneStatus (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a PHONESTATUS packet that contains information about the phone's status 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.

Reserved13 (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): MUST present upon successful completion of the request. MUST contain a PHONESTATUS packet. The contents of this field are DWORD-aligned.