TSPI_phoneSetDisplay

The TSPI_phoneSetDisplay function causes the specified string to be displayed on the specified open phone device.

LONG TSPIAPI TSPI_phoneSetDisplay(
  DRV_REQUESTID dwRequestID,  
  HDRVPHONE hdPhone,          
  DWORD dwRow,                
  DWORD dwColumn,             
  LPCWSTR lpsDisplay,         
  DWORD dwSize                
);

Parameters

dwRequestID

The identifier of the asynchronous request.

hdPhone

The handle to the phone on which the string is to be displayed.

dwRow

The row on the display where the new text is to be displayed.

dwColumn

The column position on the display where the new text is to be displayed.

lpsDisplay

A pointer to the memory location where the display content is stored. The application stores the display information in the format specified as dwStringFormat in the phone's PHONECAPS structure.

dwSize

The size in bytes of the information pointed to by lpDisplay.

Return Values

Returns dwRequestID, or an error number if an error occurs. The lResult actual parameter of the corresponding ASYNC_COMPLETION is zero if the function succeeds or it is an error number if an error occurs. Possible return values are as follows:

PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPARAM, PHONEERR_OPERATIONUNAVAIL, PHONEERR_NOMEM.

Remarks

The specified display information is written to the phone's display, starting at the specified positions. This operation overwrites previously displayed information. If the amount of information exceeds the size of the display, the information is truncated. The amount of information that can be displayed is at most (dwNumRows * dwNumColumns) elements in size. The dwNumRows and dwNumColumns members are available in the PHONECAPS structure returned by TSPI_phoneGetDevCaps; they are zero-based.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 1.3 or later.
  Header: Declared in Tspi.h.

See Also

ASYNC_COMPLETION, PHONECAPS, TSPI_phoneGetDevCaps, TSPI_phoneGetDisplay