Share via

phoneSetRing

  • Article

This function rings the specified open phone device using the specified ring mode and volume.

LONG WINAPI phoneSetRing(
  HPHONE hPhone,
  DWORD dwRingMode,
  DWORD dwVolume 
);

Parameters

  • hPhone
    Handle to the open phone device. The application must be the owner of the phone device.
  • dwRingMode
    Ringing pattern with which to ring the phone. This parameter must be within the range of zero to the value of the dwNumRingModes member in the PHONECAPS structure. If dwNumRingModes is zero, the ring mode of the phone cannot be controlled; if dwNumRingModes is 1, a value of zero 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 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_INVALRINGMODE The ring mode is invalid.
PHONEERR_UNINITIALIZED A parameter is uninitialized.
PHONEERR_OPERATIONUNAVAIL The operation is unavailable.

Remarks

The service provider defines the actual audible ringing patterns corresponding to each of the phone's ring modes.

Note   This function is for TAPI version 2.0 and later.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Tapi.h.
Link Library: Coredll.lib.

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.