home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / inc&ad2.0 / text_autodocs / translator.doc < prev    next >
Text File  |  1992-09-01  |  1KB  |  46 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. translator.library/Translate
  6.  
  7.  
  8. translator.library/Translate                       translator.library/Translate
  9.  
  10.     NAME
  11.     Translate -- Convert an English string into narrator device phonemes.
  12.  
  13.     SYNOPSIS
  14.     rtnCode = Translate(inString, inLength, outBuffer, outLength)
  15.     D0                  A0        D0        A1         D1
  16.  
  17.     LONG Translate( STRPTR inString, LONG inLength, STRPTR outBuffer,
  18.         LONG outlen );
  19.  
  20.     FUNCTION
  21.     The translate function converts an English string into
  22.     a string of phonetic codes suitable as input to the
  23.     narrator device.  
  24.  
  25.     INPUTS
  26.     inString - pointer to English string
  27.     inLength - length of English string
  28.     outBuffer - a char array which will hold the phonetic codes
  29.     outLength - the length of the output array
  30.  
  31.     RESULTS
  32.     rtnCode - zero if no error has occured.
  33.         The only error that can occur is overflowing the outBuffer.
  34.         If Translate() determines that an overflow will occur, it
  35.         will stop the translation at a word boundary before the
  36.         overflow happens.  If this occurs, rtnCode will be a
  37.         negative number whose absolute value indicates where in
  38.         inString Translate() stopped.  The user can then use the
  39.         offset -rtnCode from the beginning of inString in a
  40.         subsequent Translate() call to continue the translation.
  41.  
  42.     SEE ALSO
  43.     narrator.device/CMD_WRITE
  44.  
  45.  
  46.