2.2.4.1.6.16 SetDisplay

The SetDisplay packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST cause the specified string to be displayed on the specified open phone device.

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

Return Values

On completion of ClientRequest, this field MUST 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 PHONEERR_Constants value indicates synchronous failure.

Returns a positive request identifier if the function is completed asynchronously or a negative error number if an error occurs. The following table lists common return values.

Name	Value
PHONEERR_INVALPHONEHANDLE	0x00000013
PHONEERR_OPERATIONUNAVAIL	0x0000001D
PHONEERR_NOTOWNER	0x0000001B
PHONEERR_OPERATIONFAILED	0x0000001C
PHONEERR_INVALPHONESTATE	0x00000014
PHONEERR_UNINITIALIZED	0x00000022
PHONEERR_INVALPOINTER	0x00000015
PHONEERR_NOMEM	0x0000001A
PHONEERR_INVALPARAM	0x00000012
PHONEERR_RESOURCEUNAVAIL	0x0000001F

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.

hPhone (4 bytes): An HPHONE. The handle to the phone on which the string is to be displayed. This field MUST have been obtained by sending the Open packet.

dwRow (4 bytes): An unsigned 32-bit integer. The row on the display where the new text is to be displayed. A valid value of dwRow is in the range 0 to dwDisplayNumRows – 1. The client obtains dwDisplayNumRows from the PHONECAPS obtained by sending a GetDevCaps packet to the remote server.

dwColumn (4 bytes): An unsigned 32-bit integer. The column position on the display where the new text is to be displayed. A valid value of dwColumn is in the range 0 to dwDisplayNumColumns –1. The client obtains dwDisplayNumColumns from the PHONECAPS obtained by sending a GetDevCaps packet to the remote server.

lpsDisplay (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field where the display content string is stored. The display information MUST have the format that is specified in the dwStringFormat member of the PHONECAPS packet, which describes the device capabilities of the phone.

dwSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, including the null terminator, of the information that is pointed to by lpsDisplay.

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.

VarData (variable): MUST contain a display content string.

The contents of this field are DWORD-aligned.