@DataBase   "ATalkARexx.guide"

@REMARK "$VER: ATalkARexx.guide 1.5 (09/30/98) by James T. Steichen

@REMARK Written by Jim Steichen, Copyright (c) 1998.

@WIDTH 75
@WORDWRAP

@INDEX main
@NODE main  "AmigaTalk© 1998 ARexx documentation:"

  Herein is documented the ARexx Commands that @{B}TheBrowser@{UB}
  can issue to the @{U}AmigaTalk@{UU} program.

  ARexx commands recognized by @{B}AmigaTalk@{UB}:

  @{" PlaceCodesInFile " LINK "PlaceCodesInFile"}
  @{" PurgeClass       " LINK "PurgeClass"}
  @{" ReloadClass      " LINK "ReloadClass"}
  @{" GetClassListType " LINK "GetClassListType"}
  @{" ReloadMethod     " LINK "ReloadMethod"}
  @{" AddClass         " LINK "AddClass"}
  @{" AddMethod        " LINK "AddMethod"}
  @{" Quit             " LINK "Quit"}
  @{" GetError         " LINK "GetError"}
  @{" GetClassFileName " LINK "GetClassFileName"}
  @{" ReportStatus     " LINK "ReportStatus"}

@ENDNODE

@NODE PlaceCodesInFile "PlaceCodesInFile command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = PlaceCodesInFile filename classname methodname@{FG TEXT}

   Get the byteCodes for the given method & given class & write them
   to the filename given.

@ENDNODE

@NODE PurgeClass "PurgeClass command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = PurgeClass classname@{FG TEXT}

   Remove the given class from the @{B}AmigaTalk@{UB} internal Class Dictionary.

@ENDNODE

@NODE ReloadClass "ReloadClass command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = ReloadClass tempfilename@{FG TEXT}

   Load the contents of the given file into the system using the
   @{I})i system directive@{UI} of @{B}AmigaTalk@{UB}.

@ENDNODE

@NODE GetClassListType "GetClassListType command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}typestring = GetClassListType@{FG TEXT}

   Get a string from a Requester that describes the first class 
   description file set to load into @{B}TheBrowser@{UB}.  @{B}TheBrowser@{UB} only 
   executes this command once on startup.

@ENDNODE

@NODE ReloadMethod "ReloadMethod command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = ReloadMethod filename classname methodname@{FG TEXT}

   Using the @{I})i system directive@{UI}, load in the given method from the given
   class & located in the given file.

@ENDNODE

@NODE AddClass "AddClass command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = AddClass filename classname@{FG TEXT}

   Using the @{I})i system directive@{UI}, load in the given class
   located in the given file.

@ENDNODE

@NODE AddMethod "AddMethod command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}success = AddMethod filename classname methodname@{FG TEXT}

   Using the @{I})i system directive@{UI}, load in the given method
   from the given class & located in the given file.

@ENDNODE

@NODE Quit "Quit command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}Quit@{FG TEXT}

   Tell @{B}AmigaTalk@{UB} to shut down the ARexx Port, because @{B}TheBrowser@{UB} has
   been closed.

@ENDNODE

@NODE GetError "GetError command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}errorstring = GetError errornumber@{FG TEXT}

   Translate the given error number into an error description string.

@ENDNODE

@NODE GetClassFileName "GetClassFileName command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}filename = GetClassFileName classname@{FG TEXT}

   Return the source filename of the given class.

@ENDNODE

@NODE ReportStatus "ReportStatus command:"
@PREV main

   @{B}SYNOPSIS@{UB}
   
     @{FG SHINE}status = ReportStatus@{FG TEXT}

   This command currently does nothing.

@ENDNODE