3.1.7.21 TSPI_phoneSetData

Syntax

LONG TSPI_phoneSetData(dwRequestID, hdPhone, dwDataID, lpData, dwSize)
This function downloads the information in the specified buffer to the opened phone device at the selected data ID.

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 into which data is to be downloaded.

DWORD dwDataID
Specifies where in the phone device the buffer is to be downloaded.

LPVOID const lpData
Specifies a far pointer to the memory location where the data is to be downloaded from.

DWORD dwSize
Specifies the size of the buffer in bytes.

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_INVALDATAID
The specified data ID 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_OPERATIONUNAVAIL
The specified operation is not available.

PHONEERR_OPERATIONFAILED
The specified operation failed for unspecified reasons.

Comments

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

See Also

Functions: TSPI_phoneGetDevCaps, TSPI_phoneGetData
Data Types: PHONECAPS