| Syntax | LONG TSPI_phoneSetDisplay(dwRequestID, hdPhone, dwRow, dwColumn, lpsDisplay, dwSize) |
| This function causes the specified string to be displayed on the specified open phone device. | |
| Parameters | DRV_REQUESTID dwRequestID Specifies the identifier of the asynchronous request. The Service Provider returns this value if the function completes asynchronously. |
| HDRVPHONE hdPhone Specifies the Service Provider's opaque handle to the phone on which the string is to be displayed. | |
| DWORD dwRow Specifies the row on the display where the new text is to be displayed. | |
| DWORD dwColumn Specifies the column position on the display where the new text is to be displayed. | |
| LPCSTR const lpsDisplay Specifies a far pointer to the memory location where the display content is stored. The display information must have the format specified as dwStringFormat in the phone's device capabilities. | |
| DWORD dwSize Specifies the size in bytes of the information pointed to by lpDisplay. | |
| Return Value | Returns zero if the function is successful, the (positive) dwRequestID value if the function will be completed asynchronously, or a negative error number if an error has occurred. Possible error returns are: |
| PHONEERR_INVALPHONEHANDLE The specified device handle is invalid. | |
| PHONEERR_INVALPHONESTATE The phone device is not in a valid state for the requested operation. | |
| PHONEERR_INVALPOINTER The specified pointer parameter is invalid. | |
| PHONEERR_INVALPARAM The row or column parameters are invalid or out of range. | |
| PHONEERR_OPERATIONUNAVAIL The specified operation is not available. | |
| PHONEERR_OPERATIONFAILED The specified operation failed for unspecified reasons | |
| Comments | 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, then the information will be truncated. The amount of information that can be displayed is at most (dwNumRows * dwNumColumns) elements in size. dwNumRows and dwNumColumns are available in the PHONECAPS structure returned by TSPI_phoneGetDevCaps; they are zero-based. |
| See Also | Functions: TSPI_phoneGetDevCaps, TSPI_phoneGetDisplay Data Types: PHONECAPS |