IVTxtAttributes::TTSModeGet

This method retrieves the globally unique identifier (GUID) of the current text-to-speech (TTS) mode for a voice text site.

Syntax

HRESULT TTSModeGet( GUID *pgVoice);

Parameters

pgVoice

[out] Pointer to a variable that receives the GUID assigned to the text-to-speech mode.

Return Values

NOERROR

The method successfully retrieved the GUID of the current TTS mode for a voice text site.

VTXTERR_INVALIDMODE

The text-to-speech mode is invalid, or the application has not been registered to use the voice text on the site.

VTXTERR_INVALIDPARAM

A parameter is invalid.

VTXTERR_OUTOFMEM

There is not enough memory.

Remarks

A text-to-speech engine typically provides an assortment of text-to-speech modes that can be used to play speech in different voices. A voice text site uses a single text-to-speech mode, represented internally by a low-level engine object.

The text-to-speech mode for a site is saved between uses of the site, even if the user shuts down the computer in the meantime.

In Auto PC, there is usually only one TTS mode.

See Also

IVTxtAttributes::TTSModeSet