TSPI_phoneGetVolume (Compact 2013)

3/26/2014

This function returns the volume setting of the specified phone's hookswitch device.

Syntax

LONG TSPIAPI TSPI_phoneGetVolume(
  HDRVPHONE hdPhone, 
  DWORD dwHookSwitchDev,  
  LPDWORD lpdwVolume 
);

hdPhone
Handle to the phone containing the hookswitch device whose volume setting is to be retrieved.

dwHookSwitchDev
Single hookswitch device whose volume level is queried. This parameter uses one of the PHONEHOOKSWITCHDEV constants.

lpdwVolume
Pointer to a DWORD-sized location into which the service provider writes the current volume setting of the hookswitch device. This is a number in the range from 0x00000000 (silence) through 0x0000FFFF (maximum volume). The actual granularity and quantization of volume settings in this range are service-provider specific.

Returns zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this method.

Value	Description
PHONEERR_INVALPHONEHANDLE	The handle to the phone is invalid.
PHONEERR_RESOURCEUNAVAIL	The resource is unavailable.
PHONEERR_INVALPHONESTATE	The phone state is invalid.
PHONEERR_OPERATIONFAILED	The operation failed.
PHONEERR_INVALHOOKSWITCHDEV	The hookswitch device is invalid.
PHONEERR_OPERATIONUNAVAIL	The operation is unavailable.
PHONEERR_NOMEM	Not enough memory is available.

Header	tspi.h
Library	CellTSP.dll