Skip to content

Latest commit

 

History

History
110 lines (77 loc) · 3.62 KB

nf-tspi-tspi_phonesetdisplay.md

File metadata and controls

110 lines (77 loc) · 3.62 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tspi.TSPI_phoneSetDisplay
TSPI_phoneSetDisplay function (tspi.h)
The TSPI_phoneSetDisplay function causes the specified string to be displayed on the specified open phone device.
TSPI_phoneSetDisplay
TSPI_phoneSetDisplay function [TAPI 2.2]
_tspi_tspi_phonesetdisplay
tspi.tspi_phonesetdisplay
tspi/TSPI_phoneSetDisplay
tspi\tspi_phonesetdisplay.htm
tapi3
c320122c-037a-40f5-8314-6aa3352cc994
12/05/2018
TSPI_phoneSetDisplay, TSPI_phoneSetDisplay function [TAPI 2.2], _tspi_tspi_phonesetdisplay, tspi.tspi_phonesetdisplay, tspi/TSPI_phoneSetDisplay
tspi.h
Windows
Windows
19H1
TSPI_phoneSetDisplay
tspi/TSPI_phoneSetDisplay
c++
APIRef
kbSyntax
UserDefined
Tspi.h
TSPI_phoneSetDisplay

TSPI_phoneSetDisplay function

-description

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

-parameters

-param dwRequestID

The identifier of the asynchronous request.

-param hdPhone

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

-param dwRow

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

-param dwColumn

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

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

-param dwSize

The size in bytes, including the null terminator, of the information pointed to by lpDisplay.

-returns

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.

-see-also

ASYNC_COMPLETION

PHONECAPS

TSPI_phoneGetDevCaps

TSPI_phoneGetDisplay