TextToSpeechLoadUserDictionary

The TextToSpeechLoadUserDictionary call loads a user-defined pronunciation dictionary into the text-to-speech system.

Syntax

MMRESULT TextToSpeechLoadUserDictionary

(LPTTS_HANDLE_T phTTS,
LPSTR pszFileName)

Parameters

LPTTS_HANDLE_T phTTS

Specifies a text-to-speech handle.

 

LPSTR pszFileName

Points to a NULL terminated string that specifies the name of the user dictionary file to be loaded.

Return Value

This call returns a value of type MMRESULT. The return value is zero if the call is successful. The return value is one of the following constants:

Constant

Description

MMSYSERR_NOERROR

Normal successful completion (zero).

MMSYSERR_INVALHANDLE

The text-to-speech handle was invalid.

MMSYSERR_NOMEM

Unable to allocate memory for dictionary.

MMSYSERR_INVALPARAM

Dictionary file not found or an invalid dictionary file name.

MMSYSERR_ERROR

Illegal dictionary format or a dictionary is already loaded.

 

 

Comments

This call loads a dictionary created by the windict or userdict applet. Any previously loaded user dictionary must be unloaded before loading a new user dictionary. Note that the text-to-speech system will automatically load a user dictionary, user.dic, at startup if it exists in the home directory.

See Also

btn_mini.gif Dictionary Functions (UNIX)

btn_mini.gif Dictionary Functions (Windows)

btn_mini.gif TextToSpeechUnloadUserDictionary