TSPI_phoneGetVolume (Windows CE 5.0)
This function returns the volume setting of the specified phone's hookswitch device.
LONG TSPIAPI TSPI_phoneGetVolume(HDRVPHONEhdPhone,DWORDdwHookSwitchDev,LPDWORDlpdwVolume);
Parameters
- 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.
Return Values
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
OS Versions: Windows CE 3.0 and later.
Header: Tapicomn.h.
Link Library: Coredll.lib.
See Also
TSPI_phoneGetDevCaps | TSPI_phoneSetVolume
Send Feedback on this topic to the authors