# Application Programming Interface (API) Reference

# Data Types

The following data types are used. They are listed in alphabetic order.

## SmArg

Speech argument list structure.

    typedef struct _SmArg
    (CHAR         name;
    AmArgVal      value;
      )   SmArg;

    typedef SmArg SmArg;

Fields:

name | Name of speech argument.
value | Value of speech argument if size of argument is less than or equal to size of (long); otherwise, a pointer to the speech argument value.

## SmArgVal

Value of speech argument if size of argument is less than or equal to sizeof(long); otherwise, a pointer to the speech argument value.

    typedef LONG  SmArgVal;

## caddr_t

Pointer to character-aligned data.

    typedef CHAR  caddr_t;

## SmHandler

Return value from callback-handler function.

    typedef INT  SmHandler;

## SmMsg

Pointer to message between speech engine and application.

    typedef VOID  SM_MSG;

## SM_VOCWORD

Vocabulary word-attribute structure.

    typedef struct _SM_VOCWORD (
    LONG       flags;
    SHORT      spelling_size;
    CHAR       spelling;
      ) SM_VOCWORD;

    typedef SM_VOCWORD  SM_VOCWORD;

Fields:

flags | Reserved for internal use.
spelling_size | Number of chars in word spelling plus one for terminating NULL.
spelling | Word spelling.

## SM_WORD

Word-attribute structure.

    typedef struct _SM_WORD (
    LONG       tag;
    LONG       flags;
    LONG       score;
    SHORT      spelling_size;
    CHAR       spelling;
    SHORT      vocab_size;
    CHAR       vocab;
      ) SM_WORD;

    typedef SM_WORD  SM_WORD;

Fields:

tag | Unique ID defined by speech engine for this word.
flags | Formatting flags for words from predefined vocabularies.
score | Measure of word's probability.
spelling_size | Number of chars in word spelling plus one for terminating NULL.
spelling | Word spelling.
vocab_size | Number of chars in vocabulary name plus one for terminating NULL.
vocab | Vocabulary name.

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]