IVoIPMgr::RingTone

  • Article

This method sets or gets the path to the special ring tone for the phone. When an incoming call comes in, first the VoIP manager queries for a caller-specific ring tone in the caller information database. If that ring tone is empty, the ring tone path specified by IVoIPMgr::RingTone will be used. If this path is empty, the default ring tone of the device will be used.

HRESULT put_RingTone( 
  BSTR bstrRingTone
);
HRESULT get_RingTone( 
  BSTR* pbstrRingTone
);

Parameters

  • bstrRingTone, pbstrRingTone
    [in, out] The path to the special ring tone for the phone. For get_RingTone, this parameter is a pointer to a BSTR that will be filled with the ring tone path. If the ring tone path is empty, this parameter indicates the default ring tone of the device.

    The method allocates the buffer. The application releases the memory by using the SysFreeString function.

Return Values

If the HRESULT value passed to the SUCCEEDED macro returns TRUE, the method succeeded. Otherwise, the method failed.

Remarks

The VoIP manager does not validate the ring tone path. If this path is invalid or points to a file that the installed media manager does not know how to play, no sound will be played on the incoming call.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Voipmanager.h, Voipmanager.idl.
Link Library: Voipguid.lib.

See Also

VoIP Application Interface Layer Architecture | VoIP Application Interface Layer Reference

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.