[Contents] [Index] [Help] [Retrace] [Browse <] [Browse >]


   NAME
        SendAmigaGuideCmdA - Send a command string to AmigaGuide (V34)

   SYNOPSIS
        success = SendAmigaGuideCmdA (handle, cmd, attrs );
          d0                            a0    d0   d1

        BOOL SendAmigaGuideCmdA (AMIGAGUIDECONTEXT, STRPTR, struct TagItem *)
;

        success = SendAmigaGuideCmd (handle, cmd, tag1, ...);

        BOOL SendAmigaGuideCmd (AMIGAGUIDECONTEXT, STRPTR, Tag);

   FUNCTION
        This function sends a command string to an AmigaGuide system.  The
        command can consist of any valid AmigaGuide action command.

        The following are the currently valid action commands:

        ALINK <name> - Load the named node into a new window.

        LINK <name> - Load the named node.

        RX <macro> - Execute an ARexx macro.

        RXS <cmd> - Execute an ARexx string file.  To display a picture,
            use 'ADDRESS COMMAND DISPLAY <picture name>', to
            display a text file 'ADDRESS COMMAND MORE <doc>'.

        CLOSE - Close the window (should only be used on windows
            that were started with ALINK).

        QUIT - Shutdown the current database.

   INPUTS
        handle - Handle to an AmigaGuide system.

        cmd - Command string.

        attrs - Future expansion, must be set to NULL for now.

   TAGS
        AGA_Context (ULONG) - Data is used as an index into nag_Context
            array.  This is used to build and send a LINK command.

   EXAMPLE

        /* bring up help on a particular subject */
        SendAmigaGuideCmd(handle, "LINK MAIN", NULL);

   RETURNS
        Returns TRUE if the message was sent, otherwise returns FALSE.

   BUGS
        ALINK does not open a new window when using V39.

   SEE ALSO