Platform SDK: TAPI

phoneSetData

The phoneSetData function downloads the information in the specified buffer to the opened phone device at the selected data identifier.

LONG WINAPI phoneSetData(
  HPHONE hPhone,        
  DWORD dwDataID,       
  LPVOID const lpData,  
  DWORD dwSize          
);

Parameters

hPhone
A handle to the open phone device. The application must be the owner of the phone.
dwDataID
Where in the phone device the buffer is to be downloaded.
lpData
A pointer to the memory location where the data is to be downloaded from.
dwSize
The size of the buffer, in bytes.

Return Values

Returns a positive request identifier if the function is completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding PHONE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. Possible return values are:

PHONEERR_INVALPHONEHANDLE, PHONEERR_OPERATIONUNAVAIL, PHONEERR_NOTOWNER, PHONEERR_NOMEM, PHONEERR_INVALDATAID, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_UNINITIALIZED.

Remarks

The phoneSetData function downloads a maximum of dwSize bytes from lpData to the phone device. The format of the data, its meaning to the phone device, and the meaning of the data identifier are service provider-specific. The data in the buffer or the selection of a data identifier may act as commands to the phone device.

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 Tapi.h.
  Library: Use Tapi32.lib.

See Also

TAPI 2.2 Reference Overview, Supplementary Phone Service Functions, PHONE_REPLY