ITAutomatedPhoneControl::get_Tone method (tapi3if.h)

The get_Tone method returns a PHONE_TONE enum value indicating the type of tone, if any, that the phone is currently playing. If no tone is currently being played, the PHONE_TONE value returned is PT_SILENCE. This method has knowledge only of tones initiated by the StartTone method on this interface.

Syntax

HRESULT get_Tone(
  [out] PHONE_TONE *pTone
);

Parameters

[out] pTone

PHONE_TONE descriptor of tone being played.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an error value.

Requirements

See also

ITAutomatedPhoneControl

StartTone