SetRingTone

Description

Specifies whether the receipt of an incoming call will play a sound file assigned by the PhoneCall object’s RingTone property.

Applies to

PhoneCall objects

Syntax

objectname.SetRingTone ( wavefile )

Argument	Description
objectname	The name of the PhoneCall object.
wavefile	A read-only string that assigns a WAV sound file to the PhoneCall object’s RingTone property.

Returns

Integer. Returns 1 for success and a negative value if an error occurs.

Usage

You can use an empty string for the wavefile argument to set the ring tone to the default ring (typically \Windows\Rings\DefaultRing.wav) stored on the device.

Examples

Example 1

The following script for a Set Ring button sets the ring tone for the PhoneCall object.

String ls_sound

Integer li_return

ls_sound = "\Windows\Rings\MySpecialRing.wav"
if FileExists(ls_sound) = false then
   MessageBox("Error", "Sound file does not exist: " &
      + ls_sound)
else
      li_return = pcall_1.SetRingTone (ls_sound)
end if