Inside Macintosh: Sound /

Chapter 4 - Speech Manager / Speech Manager Reference

Data Structures

Delimiter Information Records

A delimiter information record defines the characters used to indicate the beginning and end of a command embedded in text. A delimiter can be one or two characters. The DelimiterInfo data type defines a delimiter information record.

TYPE DelimiterInfo =
RECORD
   startDelimiter:   PACKED ARRAY[0..1] OF Char;
   endDelimiter:     PACKED ARRAY[0..1] OF Char;
END;

Field Description

startDelimiter

The start delimiter for an embedded command. By default, the start delimiter is "[[".

endDelimiter

The end delimiter for an embedded command. By default, the end delimiter is "]]".

Ordinarily, applications that support embedded speech commands should not change the start or end delimiters. However, if for some reason you must change the delimiters, you can use the SetSpeechInfo function with the soCommandDelimiter selector. For example, you might do this if a text buffer naturally includes the delimiter strings. Before passing such a buffer to the Speech Manager, you can change the delimiter strings to some two-character sequences not used in the buffer and then change the delimiter strings back once processing of the buffer is complete.

If a single-byte delimiter is desired, it should be followed by a NIL (0) byte. If the delimiter strings both consist of two NIL bytes, embedded command processing is disabled.