Share via


IVoIPCallerInfoRecord::RingTone (Windows Embedded CE 6.0)

1/6/2010

This method sets or retrieves the path to the ring tone to use when the caller is calling.

Syntax

HRESULT put_RingTone( 
  BSTR bstrRingTonePath 
);
HRESULT get_RingTone( 
  BSTR* pbstrRingTonePath 
);

Parameters

  • bstrRingTonePath, pbstrRingTonePath
    [in],[out, retval] The path to the ring tone. For the put_RingTone method, set this value to NULL or " " for the default ring.

    For get_RingTone, this parameter is a pointer to a BSTR that will be filled with the ring tone, or an empty string if there is no entry. The method allocates the buffer. The application is responsible for releasing the memory by using the SysFreeString function.

Return Value

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

Remarks

Note

This documentation applies to functionality implemented in sample code for the VAIL Database Store. For more information, see VAIL Database Store Reference.

Requirements

Header Voipstore.h, voipstore.idl
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

IVoIPCallerInfoRecord
VAIL Database Store Reference

Other Resources

SysFreeString