Carbon


UseDictionary

Header: SpeechSynthesis.h Carbon status: Supported

Installs a designated dictionary into a speech channel.

OSErr UseDictionary (
    SpeechChannel chan, 
    Handle dictionary
);
Parameter descriptions
chan

The speech channel into which a dictionary is to be installed.

dictionary

A handle to the dictionary data. This is often a handle to a resource of type ‘dict’.

function result

A result code.

DISCUSSION

The UseDictionary function attempts to install the dictionary data referenced by the dictionary parameter into the speech channel referenced by the chan parameter. The synthesizer will use whatever elements of the dictionary resource it considers useful to the speech conversion process. Some speech synthesizers might ignore certain types of dictionary entries.

After the UseDictionary function returns, your application is free to release any storage allocated for the dictionary handle. The search order for application-provided dictionaries is last-in, first-searched.

All details of how an application-provided dictionary is represented within the speech synthesizer are dependent on the specific synthesizer implementation and are private to the synthesizer.

Pronunciation dictionaries allow your application to override the default Speech Manager pronunciations of individual words, such as names with quirky spellings.

SPECIAL CONSIDERATIONS

Because the UseDictionary function might move memory, you should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)