| Syntax | LONG TSPI_phoneGetDisplay(dwRequestID, hdPhone, lpDisplay) This function returns the current contents of the specified phone display. |
| 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 to be queried. | |
| LPVARSTRING lpDisplay Specifies a far pointer to the memory location where the display content is to be stored, of type VARSTRING. | |
| 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_INVALPOINTER The specified pointer parameter is invalid. | |
| PHONEERR_INVALPHONESTATE The phone device is not in a valid state for the requested operation. | |
| PHONEERR_OPERATIONUNAVAIL The specified operation is not available. | |
| PHONEERR_OPERATIONFAILED The specified operation failed for unspecified reasons. | |
| Comments | The lpDisplay memory area should be at least (dwNumRows * dwNumColumns) elements in size to receive all of the display information. dwNumRows and dwNumColumns are available in the PHONECAPS structure returned by TSPI_phoneGetDevCaps. |
| See Also | Functions: TSPI_phoneGetDevCaps, TSPI_phoneSetDisplay |
| Data Types: PHONECAPS, VARSTRING | |
| Fields: | The following table indicates which fields of the VARSTRING data structure are filled in by the Service Provider and which fields are filled in by the TAPI DLL. The Service Provider must preserve (i.e., must not overwrite) the values filled in by the TAPI DLL. |
| Field Name | TAPI DLL | Service Provider |
| dwTotalSize; | X | |
| dwNeededSize; | X | |
| dwUsedSize; | X | |
| dwStringFormat; | X | |
| dwStringSize; | X | |
| dwStringOffset; | X |