@database "translator"

@Node Main "translator.doc"
@toc "Includes_&_Autodocs/Main"
    @{" Translate() " Link "Translate()"}
@EndNode

@Node "Translate()" "translator.library/Translate"

@{b}    NAME@{ub}
	Translate -- Convert an English string into narrator device phonemes.

@{b}    SYNOPSIS@{ub}
	rtnCode = Translate(inString, inLength, outBuffer, outLength)
	D0                  A0        D0        A1         D1

	@{"LONG" Link "includes/exec/types.h/Main" 35} Translate( @{"STRPTR" Link "includes/exec/types.h/Main" 53} inString, @{"LONG" Link "includes/exec/types.h/Main" 35} inLength, @{"STRPTR" Link "includes/exec/types.h/Main" 53} outBuffer,
	    @{"LONG" Link "includes/exec/types.h/Main" 35} outlen );

@{b}    FUNCTION@{ub}
	The translate function converts an English string into
	a string of phonetic codes suitable as input to the
	narrator device.  

@{b}    INPUTS@{ub}
	inString - pointer to English string
	inLength - length of English string
	outBuffer - a char array which will hold the phonetic codes
	outLength - the length of the output array

@{b}    RESULTS@{ub}
	rtnCode - zero if no error has occured.
	    The only error that can occur is overflowing the outBuffer.
	    If Translate() determines that an overflow will occur, it
	    will stop the translation at a word boundary before the
	    overflow happens.  If this occurs, rtnCode will be a
	    negative number whose absolute value indicates where in
	    inString Translate() stopped.  The user can then use the
	    offset -rtnCode from the beginning of inString in a
	    subsequent Translate() call to continue the translation.

@{b}    SEE ALSO@{ub}
	@{"narrator.device/CMD_WRITE" Link "trackdisk/CMD_WRITE"}

@EndNode

