phoneGetDisplay function (tapi.h)

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

Syntax

LONG phoneGetDisplay(
  HPHONE      hPhone,
  LPVARSTRING lpDisplay
);

Parameters

hPhone

Handle to the open phone device.

lpDisplay

Pointer to the memory location where the display content is to be stored, of type VARSTRING.

Return value

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPOINTER, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPHONESTATE, PHONEERR_STRUCTURETOOSMALL, PHONEERR_OPERATIONUNAVAIL, PHONEERR_UNINITIALIZED, PHONEERR_NOMEM.

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

Requirements

See also

PHONECAPS

Supplementary Phone Service Functions

TAPI 2.2 Reference Overview

VARSTRING

phoneGetDevCaps