Platform SDK: TAPI

phoneGetVolume

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

LONG WINAPI 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 one of the PHONEHOOKSWITCHDEV_ Constants.
lpdwVolume
A pointer to a DWORD. The function returns the current volume setting of the hookswitch device in this location. 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.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 1.3 or later.
  Header: Declared in Tapi.h.
  Library: Use Tapi32.lib.

See Also

TAPI 2.2 Reference Overview, Supplementary Phone Service Functions