Share via


phoneGetVolume (Compact 2013)

3/26/2014

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

Syntax

LONG WINAPI phoneGetVolume(
  HPHONE hPhone,
  DWORD dwHookSwitchDev,
  LPDWORD lpdwVolume 
);

Parameters

  • hPhone
    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
    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 Value

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

Value

Description

PHONEERR_INVALPHONEHANDLE

The handle to the open phone device is invalid.

PHONEERR_NOMEM

Not enough memory is available.

PHONEERR_INVALPHONESTATE

The phone state is invalid.

PHONEERR_RESOURCEUNAVAIL

The resources are unavailable.

PHONEERR_INVALPOINTER

The pointer is invalid.

PHONEERR_OPERATIONFAILED

The operation failed.

PHONEERR_INVALHOOKSWITCHDEV

The hookswitch device is invalid.

PHONEERR_UNINITIALIZED

A parameter is uninitialized.

PHONEERR_OPERATIONUNAVAIL

The operation is unavailable.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Phone Device Functions