TSPI_phoneGetGain (Windows Embedded CE 6.0)

1/6/2010

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

Syntax

LONG TSPIAPI TSPI_phoneGetGain(
  HDRVPHONE hdPhone, 
  DWORD dwHookSwitchDev,  
  LPDWORD lpdwGain 
);

Parameters

• hdPhone
  Handle to the phone whose gain is to be retrieved.

• dwHookSwitchDev
  Hookswitch device whose gain level is queried. This parameter may be one and only one of thePHONEHOOKSWITCHDEV constants.

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

Return Value

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

Requirements

See Also

Reference

TSPI Phone Device Functions
TSPI_phoneGetDevCaps
TSPI_phoneSetGain