TSPI_phoneGetGain
A version of this page is also available for
4/8/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.
| 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. |
Requirements
| Header | tapicomn.h |
| Library | coredll.lib |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |