TSPI_phoneGetDisplay

The TSPI_phoneGetDisplay function returns the current contents of the specified phone display.

LONG TSPIAPI TSPI_phoneGetDisplay(
  HDRVPHONE hdPhone,     
  LPVARSTRING lpDisplay  
);

Parameters

hdPhone

The handle to the phone to be queried.

lpDisplay

A pointer to the memory location where the display content is to be stored by the provider, of type VARSTRING. Prior to calling TSPI_phoneGetDisplay, the application sets the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Values

Returns zero if the function succeeds, or an error number if an error occurs. Possible return values are as follows:

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

Remarks

The lpDisplay memory area should be at least dwDisplayNumRows * dwDisplayNumColumns elements in size to receive all of the display information. The dwDisplayNumRows and dwDisplayNumColumns members are available in the PHONECAPS structure returned by TSPI_phoneGetDevCaps.

The service provider fills in all the members of the VARSTRING data structure, except for dwTotalSize, which is filled in by TAPI. The service provider must not overwrite the dwTotalSize member.

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

PHONECAPS, TSPI_phoneGetDevCaps, TSPI_phoneSetDisplay, VARSTRING