phoneSetVolume
A version of this page is also available for
4/8/2010
This function sets the volume of the speaker component of the specified hookswitch device to the specified level.
Note
This function is for TAPI version 2.0 and later.
Syntax
LONG WINAPI phoneSetVolume(
HPHONE hPhone,
DWORD dwHookSwitchDev,
DWORD dwVolume
);
Parameters
- hPhone
Handle to the open phone device. The application must be the owner of the phone.
- dwHookSwitchDev
Hookswitch device whose speaker's volume is to be set, one of the PHONEHOOKSWITCHDEV constants.
- dwVolume
New volume setting of the 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. A value for dwVolume that is out of range is set to the nearest value in the range.
Return Value
Returns a positive request identifier if the function is completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding PHONE_REPLY message is zero if the function succeeds or it is 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_NOTOWNER |
The application is not the owner of this call. |
PHONEERR_RESOURCEUNAVAIL |
The resources are unavailable. |
PHONEERR_INVALPHONESTATE |
The phone state 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 | coredll.lib |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |