phoneSetRing
The phoneSetRing
function rings the specified open phone device using the specified ring mode
and volume.
LONG phoneSetRing(
|
HPHONE hPhone, |
|
|
DWORD dwRingMode, |
|
|
DWORD dwVolume |
|
|
); |
|
Parameters
hPhone
A handle to
the open phone device. The application must be the owner of the phone device.
dwRingMode
The ringing
pattern with which to ring the phone. This parameter must be within the range
of 0 to the value of the dwNumRingModes field in the PHONECAPS structure. If dwNumRingModes
is 0, the ring mode of the phone cannot be controlled; if dwNumRingModes
is 1, a value of 0 for dwRingMode indicates that the phone should not be
rung (silence), and other values from 1 to dwNumRingModes are valid ring
modes for the phone device.
dwVolume
The volume
level with which the phone is ringing. 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 Values
Returns a
positive request ID if the function will be completed asynchronously or a
negative error number if an error has occurred. The dwParam2 parameter
of the corresponding PHONE_REPLY
message is zero if the function is successful or it is a negative error number
if an error has occurred. Possible return values are:
PHONEERR_INVALPHONEHANDLE,
PHONEERR_NOMEM, PHONEERR_NOTOWNER, PHONEERR_RESOURCEUNAVAIL,
PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALRINGMODE,
PHONEERR_UNINITIALIZED, PHONEERR_OPERATIONUNAVAIL.
Remarks
The service
provider defines the actual audible ringing patterns corresponding to each of
the phone's ring modes.
See Also