2.2.4.1.3.75 SetStatusMessages

The SetStatusMessages packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST enable an application to specify which notification packets to receive for events that are related to status changes for the specified line or any of its addresses.


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

hLine

dwLineStates

dwAddressStates

Reserved2

Reserved3

Reserved4

Reserved5

Reserved6

Reserved7

Reserved8

Reserved9

Reserved10

Reserved11

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

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 LINEERR_Constants value indicates failure. The remote server MUST complete this call synchronously.

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

Name

Value

LINEERR_INVALADDRESSSTATE

0x80000013

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_INVALLINEHANDLE

0x8000002B

LINEERR_RESOURCEUNAVAIL

0x8000004B

LINEERR_INVALLINESTATE

0x8000002C

LINEERR_UNINITIALIZED

0x80000050

LINEERR_NOMEM

0x80000044

LINEERR_OPERATIONUNAVAIL

0x80000049

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

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

dwLineStates (4 bytes): An unsigned 32-bit integer. The bit array that identifies the line-device status changes for which a packet is sent to the application. This parameter MUST use one or more of the LINEDEVSTATE_Constants.

dwAddressStates (4 bytes): An unsigned 32-bit integer. The bit array that identifies the address status changes for which a packet is sent to the application. This parameter MUST use one or more of the LINEADDRESSSTATE_Constants.

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.