phoneGetVolume
The phoneGetVolume function returns the volume setting of the specified phone's hookswitch device.
LONG phoneGetVolume(
HPHONE hPhone,
DWORD dwHookSwitchDev,
LPDWORD lpdwVolume
);
Parameters
-
hPhone
-
A handle to the open phone device.
-
dwHookSwitchDev
-
A single hookswitch device whose volume level is queried. This parameter uses the following PHONEHOOKSWITCHDEV_ constants:
-
PHONEHOOKSWITCHDEV_HANDSET
-
The phone's handset.
-
PHONEHOOKSWITCHDEV_SPEAKER
-
The phone's speakerphone or adjunct.
-
PHONEHOOKSWITCHDEV_HEADSET
-
The phone's headset.
-
lpdwVolume
-
A pointer to a DWORD-sized location containing the current volume setting of the hookswitch device. The dwVolume parameter specifies the volume level of the hookswitch device. This is a number in the range 0x00000000 (silence) to 0x0000FFFF (maximum volume). The actual granularity and quantization of volume settings in this range are service provider-specific.
Return Values
Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:
PHONEERR_INVALPHONEHANDLE, PHONEERR_NOMEM, PHONEERR_INVALPHONESTATE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPOINTER, PHONEERR_OPERATIONFAILED, PHONEERR_INVALHOOKSWITCHDEV, PHONEERR_UNINITIALIZED, PHONEERR_OPERATIONUNAVAIL.
QuickInfo
Version: Use TAPI version 1.4 and later.
Header: Declared in tapi.h.
Import Library: Link with tapi32.lib.
See Also
TAPI Reference Overview, Supplementary Phone Services Functions