home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / 3_1DOCS.DMS / in.adf / autodocs.lha / doc / amigaguide.doc < prev    next >
Encoding:
Text File  |  1993-10-15  |  25.6 KB  |  847 lines
  1. TABLE OF CONTENTS
  2.  
  3. amigaguide.library/--background--
  4. amigaguide.library/--rexxhost--
  5. amigaguide.library/AddAmigaGuideHostA
  6. amigaguide.library/AmigaGuideSignal
  7. amigaguide.library/CloseAmigaGuide
  8. amigaguide.library/GetAmigaGuideAttr
  9. amigaguide.library/GetAmigaGuideMsg
  10. amigaguide.library/GetAmigaGuideString
  11. amigaguide.library/LockAmigaGuideBase
  12. amigaguide.library/OpenAmigaGuideA
  13. amigaguide.library/OpenAmigaGuideAsyncA
  14. amigaguide.library/RemoveAmigaGuideHostA
  15. amigaguide.library/ReplyAmigaGuideMsg
  16. amigaguide.library/SendAmigaGuideCmdA
  17. amigaguide.library/SendAmigaGuideContextA
  18. amigaguide.library/SetAmigaGuideAttrsA
  19. amigaguide.library/SetAmigaGuideContextA
  20. amigaguide.library/UnlockAmigaGuideBase
  21. amigaguide.library/--background--           amigaguide.library/--background--
  22.  
  23.     PURPOSE
  24.         The amigaguide.library provides a means whereby developers
  25.         can easily add on-line help abilities to their applications.
  26.  
  27. amigaguide.library/--rexxhost--               amigaguide.library/--rexxhost--
  28.  
  29.     HOST INTERFACE
  30.         amigaguide.library provides an ARexx function host interface that
  31.         enables ARexx programs to take advantage of the features of
  32.         AmigaGuide.  The functions provided by the interface are directly
  33.         related to the functions described herein, with the differences
  34.         mostly being in the way they are called.
  35.  
  36.         The function host library vector is located at offset -30 from
  37.         the library. This is the value you provide to ARexx in the
  38.         AddLib() function call.
  39.  
  40.     FUNCTIONS
  41.         ShowNode (PUBSCREEN,DATABASE,NODE,LINE,XREF)
  42.  
  43.         LoadXRef (NAME)
  44.  
  45.         GetXRef (NODE)
  46.  
  47. amigaguide.library/AddAmigaGuideHostA   amigaguide.library/AddAmigaGuideHostA
  48.  
  49.      NAME
  50.         AddAmigaGuideHostA - Add a dynamic node host.           (V34)
  51.  
  52.      SYNOPSIS
  53.         handle = AddAmigaGuideHostA (hook, name, attrs);
  54.         d0                           a0    d0    a1
  55.  
  56.         AMIGAGUIDEHOST AddAmigaGuideHostA (struct Hook *, STRPTR,
  57.                                            struct TagItem *);
  58.  
  59.      FUNCTION
  60.         This function adds a callback hook to the dynamic node list.
  61.  
  62.         A dynamic node allows an application to incorporate context-
  63.         sensitive or live project data within their help system.
  64.  
  65.      INPUTS
  66.         hook - The callback hook.
  67.         name - Name of the AmigaGuideHost database that you are adding.
  68.             The name must be unique.
  69.         attrs - Additional attributes.  None are defined at this time.
  70.  
  71.      RETURNS
  72.         Returns NULL if unable to add the dynamic node host, otherwise
  73.         returns a pointer to a handle that will eventually be passed
  74.         to RemoveAmigaGuideHost() to remove the dynamic node host from
  75.         the list.
  76.  
  77.      NOTES
  78.         When AmigaGuide attempts to resolve a LINK command, it performs
  79.         the following sequence of events.
  80.  
  81.            Splits the name into a path, a database and a node (only
  82.              the node is required).
  83.            Opens the database.
  84.            Performs the following searches until the node is found:
  85.              Search the local database.
  86.              Search the local cross reference list.
  87.              Search the local dynamic node host.
  88.              Search the global help file (system help).
  89.              Search the global cross reference list.
  90.              Search the global dynamic node hosts.
  91.  
  92.      SEE ALSO
  93.         RemoveAmigaGuideHostA()
  94.  
  95.      EXAMPLE
  96.  
  97.         /* Hook dispatcher */
  98.         ULONG __asm hookEntry(
  99.                 register __a0 struct Hook *h,
  100.                 register __a2 VOID *obj,
  101.                 register __a1 VOID *msg)
  102.         {
  103.             /* Pass the parameters on the stack */
  104.             return ((h->h_SubEntry)(h, obj, msg));
  105.         }
  106.  
  107.         ULONG __saveds
  108.         dispatchAmigaGuideHost (struct Hook *h, STRPTR db, Msg msg)
  109.         {
  110.             struct opNodeIO *onm = (struct opNodeIO *) msg;
  111.             ULONG retval = 0;
  112.  
  113.             switch (msg->MethodID)
  114.             {
  115.                 /* Does this node belong to you? */
  116.                 case HM_FINDNODE:
  117.                     {
  118.                         struct opFindHost *ofh = (struct opFindHost *) msg;
  119.  
  120.                         kprintf("Find [%s] in %sn", ofh->ofh_Node, db);
  121.  
  122.                         /* Return TRUE to indicate that it's your node,
  123.                          * otherwise return FALSE. */
  124.                         retval = TRUE;
  125.                     }
  126.                     break;
  127.  
  128.                 /* Open a node. */
  129.                 case HM_OPENNODE:
  130.                     kprintf("Open [%s] in %sn", onm->onm_Node, db);
  131.  
  132.                     /* Provide the contents of the node */
  133.                     onm->onm_DocBuffer = TEMP_NODE;
  134.                     onm->onm_BuffLen   = strlen(TEMP_NODE);
  135.  
  136.                     /* Indicate that we were able to open the node */
  137.                     retval = TRUE;
  138.                     break;
  139.  
  140.                 /* Close a node, that has no users. */
  141.                 case HM_CLOSENODE:
  142.                     kprintf("Close [%s] in %sn", onm->onm_Node, db);
  143.  
  144.                     /* Indicate that we were able to close the node */
  145.                     retval = TRUE;
  146.                     break;
  147.  
  148.                 /* Free any extra memory */
  149.                 case HM_EXPUNGE:
  150.                     kprintf("Expunge [%s]n", db);
  151.                     break;
  152.  
  153.                 default:
  154.                     kprintf("Unknown method %ldn", msg->MethodID);
  155.                     break;
  156.             }
  157.  
  158.             return (retval);
  159.         }
  160.  
  161.         main(int argc, char **argv)
  162.         {
  163.             struct Hook hook;
  164.             AMIGAGUIDEHOST hh;
  165.  
  166.             /* Open the library */
  167.             if (AmigaGuideBase = OpenLibrary("amigaguide.library", 33))
  168.             {
  169.                 /* Initialize the hook */
  170.                 hook.h_Entry    = hookEntry;
  171.                 hook.h_SubEntry = dispatchAmigaGuideHost;
  172.  
  173.                 /* Add the AmigaGuideHost to the system */
  174.                 if (hh = AddAmigaGuideHost(&hook, "ExampleHost", NULL))
  175.                 {
  176.                     /* Wait until we're told to quit */
  177.                     Wait(SIGBREAKF_CTRL_C);
  178.  
  179.                     /* Try removing the host */
  180.                     while (RemoveAmigaGuideHost(hh, NULL) > 0)
  181.                     {
  182.                         /* Wait a while */
  183.                         Delay(5);
  184.                     }
  185.                 }
  186.  
  187.                 /* close the library */
  188.                 CloseLibrary(AmigaGuideBase);
  189.             }
  190.         }
  191.  
  192.      BUGS
  193.         When a dynamic node host is first added it will receive a
  194.         HM_FINDNODE message with an onm_Node of "Main".  The
  195.         AGA_HelpGroup attribute will always be zero for this
  196.         particular message.
  197.  
  198. amigaguide.library/AmigaGuideSignal       amigaguide.library/AmigaGuideSignal
  199.  
  200.     NAME
  201.         AmigaGuideSignal - Obtain aysnc AmigaGuide signal.      (V34)
  202.  
  203.     SYNOPSIS
  204.         signal = AmigaGuideSignal ( handle );
  205.         d0                          a0
  206.  
  207.         ULONG AmigaGuideSignal (AMIGAGUIDECONTEXT);
  208.  
  209.     FUNCTION
  210.         This function returns the signal bit to Wait on for AmigaGuideMsg's
  211.         for a particular AmigaGuide database.
  212.  
  213.     INPUTS
  214.         handle  - Handle to a AmigaGuide system.
  215.  
  216.     EXAMPLE
  217.         ULONG sigw, sigh;
  218.         AMIGAGUIDECONTEXT handle;
  219.  
  220.         /* get the signal bit to wait on for a AmigaGuide message */
  221.         sigh = AmigaGuideSignal(handle);
  222.  
  223.         /* add the signal bit into the total signals to wait on */
  224.         sigw |= sigh;
  225.  
  226.     RETURNS
  227.         signal  - Signal bit to Wait on.
  228.  
  229.     SEE ALSO
  230.         OpenAmigaGuideAsyncA(), GetAmigaGuideMsg(), ReplyAmigaGuideMsg()
  231.  
  232. amigaguide.library/CloseAmigaGuide         amigaguide.library/CloseAmigaGuide
  233.  
  234.      NAME
  235.         CloseAmigaGuide - Close a AmigaGuide client.            (V34)
  236.  
  237.      SYNOPSIS
  238.         CloseAmigaGuide (handle);
  239.                           a0
  240.  
  241.         VOID CloseAmigaGuide (AMIGAGUIDECONTEXT);
  242.  
  243.      FUNCTION
  244.         Closes a synchronous, or asynchronous, AmigaGuide client.
  245.  
  246.         This function will also close all windows that were opened for
  247.         the client.
  248.  
  249.      INPUTS
  250.         handle - Handle to an AmigaGuide client.
  251.  
  252.      SEE ALSO
  253.         OpenAmigaGuideA(), OpenAmigaGuideAsyncA()
  254.  
  255. amigaguide.library/GetAmigaGuideAttr     amigaguide.library/GetAmigaGuideAttr
  256.  
  257.      NAME
  258.         GetAmigaGuideAttr - Get an AmigaGuide attribute.        (V34)
  259.  
  260.      SYNOPSIS
  261.         retval = GetAmigaGuideAttr (tag, handle, storage);
  262.         d0                          d0   a0      a1
  263.  
  264.         LONG GetAmigaGuideAttr (Tag, AMIGAGUIDECONTEXT, ULONG *);
  265.  
  266.      FUNCTION
  267.         This function is used to obtain attributes from AmigaGuide.
  268.  
  269.      INPUTS
  270.         tag - Attribute to obtain.
  271.         handle - Handle to an AmigaGuide system.
  272.         storage - Pointer to appropriate storage for the answer.
  273.  
  274.      TAGS
  275.         AGA_Path (BPTR) - Pointer to the current path used by
  276.             AmigaGuide.
  277.  
  278.         AGA_XRefList (struct List *) - Pointer to the current
  279.             cross reference list.
  280.  
  281.      RETURNS
  282.  
  283.      SEE ALSO
  284.         SetAmigaGuideAttrsA()
  285.  
  286. amigaguide.library/GetAmigaGuideMsg       amigaguide.library/GetAmigaGuideMsg
  287.  
  288.     NAME
  289.         GetAmigaGuideMsg - Receive async AmigaGuide message.    (V34)
  290.  
  291.     SYNOPSIS
  292.         msg = GetAmigaGuideMsg (handle);
  293.         d0                       a0
  294.  
  295.         struct AmigaGuideMsg *GetAmigaGuideMsg (AMIGAGUIDECONTEXT);
  296.  
  297.     FUNCTION
  298.         This function returns a SIPC message from the AmigaGuide system,
  299.         if there is a message available.
  300.  
  301.     INPUTS
  302.         handle - Handle to a AmigaGuide system.
  303.  
  304.     EXAMPLE
  305.  
  306.         AMIGAGUIDECONTEXT handle;
  307.         struct AmigaGuideMsg *agm;
  308.  
  309.         /* get a AmigaGuide message */
  310.         while (agm = GetAmigaGuideMsg(handle))
  311.         {
  312.             /* process the event */
  313.             switch (agm->agm_Type)
  314.             {
  315.                 case ToolCmdReplyID:    /* a command has completed */
  316.                     if (agm->agm_Pri_Ret)
  317.                     {
  318.                         /* An error occurred, the reason is in agm_Sec_Ret.
  319.                          * The command string is in agm_Data
  320.                          */
  321.                     }
  322.                     break;
  323.  
  324.                 case ToolStatusID:      /* status message */
  325.                     if (agm->agm_Pri_Ret)
  326.                     {
  327.                         /* an error occurred, the reason is in agm_Sec_Ret */
  328.                     }
  329.                     break;
  330.  
  331.                 default:
  332.                     break;
  333.             }
  334.  
  335.             /* reply to the AmigaGuide message */
  336.             ReplyAmigaGuideMsg(agm);
  337.         }
  338.  
  339.     RETURNS
  340.         msg     - Pointer to a SIPC message or NULL if no message was
  341.                   available.
  342.  
  343.     SEE ALSO
  344.         OpenAmigaGuideAsyncA(), AmigaGuideSignal(), ReplyAmigaGuideMsg()
  345.  
  346. amigaguide.library/GetAmigaGuideString amigaguide.library/GetAmigaGuideString
  347.  
  348.     NAME
  349.         GetAmigaGuideString - Get an AmigaGuide string.
  350.                                                                 (V34)
  351.     SYNOPSIS
  352.         txt = GetAmigaGuideString (id);
  353.         d0                         d0
  354.  
  355.         STRPTR GetAmigaGuideString (ULONG);
  356.  
  357.     FUNCTION
  358.         This function is used to obtain a localized string given the
  359.         ID.
  360.  
  361.     INPUTS
  362.         ID -- Valid AmigaGuide string id.
  363.  
  364.     RETURNS
  365.         A pointer to the string.   NULL for an invalid string.
  366.  
  367.     SEE ALSO
  368.  
  369. amigaguide.library/LockAmigaGuideBase   amigaguide.library/LockAmigaGuideBase
  370.  
  371.      NAME
  372.         LockAmigaGuideBase - Lock an AmigaGuide client.         (V34)
  373.  
  374.      SYNOPSIS
  375.         key = LockAmigaGuideBase (AMIGAGUIDECONTEXT handle);
  376.                                   a0
  377.  
  378.         LONG LockAmigaGuideBase (AMIGAGUIDECONTEXT);
  379.  
  380.      FUNCTION
  381.         This function is used to lock the AmigaGuide context handle
  382.         while working with data obtained with the the
  383.         GetAmigaGuideAttr() function.
  384.  
  385.      INPUTS
  386.         handle - AMIGAGUIDECONTEXT handle obtained with
  387.             OpenAmigaGuideAsync().
  388.  
  389.      RETURNS
  390.         Returns a key to pass to UnlockAmigaGuideBase().
  391.  
  392.      SEE ALSO
  393.         UnlockAmigaGuideBase()
  394.  
  395. amigaguide.library/OpenAmigaGuideA         amigaguide.library/OpenAmigaGuideA
  396.  
  397.      NAME
  398.         OpenAmigaGuideA - Open a synchronous AmigaGuide database.
  399.  
  400.      SYNOPSIS
  401.         handle = OpenAmigaGuideA (nag, attrs);
  402.         d0                       a0   a1
  403.  
  404.         AMIGAGUIDECONTEXT OpenAmigaGuideA (struct NewAmigaGuide *,
  405.                                            struct TagItem *);
  406.  
  407.         handle = OpenAmigaGuide (nag, tag1, ...);
  408.  
  409.         AMIGAGUIDECONTEXT OpenAmigaGuide (struct NewAmigaGuide *,
  410.                                           Tag tag1, ...);
  411.  
  412.      FUNCTION
  413.         Opens a AmigaGuide database, complete with the first viewing
  414.         window, for synchronous activity.
  415.  
  416.         Before you call OpenAmigaGuide(), you must initialize a NewAmigaGuide
  417.         structure.  NewAmigaGuide is a structure that contains all the
  418.         information needed to open a database.  The NewAmigaGuide structure
  419.         must be retained until the call returns.
  420.  
  421.         The function will not return until the user closes all the
  422.         windows.
  423.  
  424.      INPUTS
  425.         nag - Pointer to an instance of a NewAmigaGuide structure.  That
  426.             structure is initialized with the following data.
  427.  
  428.                   nag_Lock
  429.                   Lock on the directory that the database is located in.
  430.                   Not needed if nag_Name contains the complete path name.
  431.  
  432.                   nag_Name
  433.                   Name of the AmigaGuide database.
  434.  
  435.                   nag_Screen
  436.                   Screen to open the viewing windows on, NULL for the
  437.                   Workbench screen.
  438.  
  439.                   nag_PubScreen
  440.                   Pointer to the name of the public screen to open on.
  441.                   Must already be opened.
  442.  
  443.                   nag_HostPort
  444.                   Name of the applications' ARexx port (currently not used).
  445.  
  446.                   nag_ClientPort
  447.                   Base name to use for the databases' ARexx port.
  448.  
  449.                   nag_Flags
  450.                   Used to specify the requirements of this database.  The
  451.                   flags are defined in <libraries/amigaguide.h>.
  452.  
  453.                   nag_Context
  454.                   NULL terminated array of context nodes, in the form of:
  455.  
  456.                         /* context array */
  457.                         STRPTR context[] =
  458.                         {
  459.                             "MAIN",
  460.                             "INTRO",
  461.                             "GADGETS",
  462.                             NULL
  463.                         };
  464.  
  465.                   The context array is not copied, but referenced,
  466.                   therefore must remain static throughout the useage of
  467.                   the AmigaGuide system.  This array is only referenced
  468.                   when using the SetAmigaGuideContext() function.
  469.  
  470.                   nag_Node
  471.                   Node to start at (does not work with OpenAmigaGuideAsync()).
  472.  
  473.                   nag_Line
  474.                   Line to start at (does not work with OpenAmigaGuideAsync()).
  475.  
  476.                   nag_Extens
  477.                   Used by V37 and beyond to pass additional arguments.
  478.  
  479.                   nag_Client
  480.                   This is a private pointer, MUST be initialized to NULL.
  481.  
  482.         attrs - Additional attributes.
  483.  
  484.      TAGS
  485.         AGA_HelpGroup (ULONG) -- Unique identifier used to identify the
  486.             AmigaGuide help windows.  See OpenWindow() and GetUniqueID().
  487.  
  488.             Default for this tag is NULL.  Applicability is (I). (V39)
  489.  
  490.      EXAMPLE
  491.  
  492.         /* Short example showing synchronous AmigaGuide access */
  493.         LONG ShowAmigaGuideFile (STRPTR name, STRPTR node, LONG line)
  494.         {
  495.             struct NewAmigaGuide nag = {NULL};
  496.             AMIGAGUIDECONTEXT handle;
  497.             LONG retval = 0L;
  498.  
  499.             /* Fill in the NewAmigaGuide structure */
  500.             nag.nag_Name = name;
  501.             nag.nag_Node = node;
  502.             nag.nag_Line = line;
  503.  
  504.             /* Open the AmigaGuide client */
  505.             if ( handle = OpenAmigaGuide(&nag, NULL))
  506.             {
  507.                 /* Close the AmigaGuide client */
  508.                 CloseAmigaGuide(handle);
  509.             }
  510.             else
  511.             {
  512.                 /* Get the reason for failure */
  513.                 retval = IoErr();
  514.             }
  515.  
  516.             return (retval);
  517.         }
  518.  
  519.      RETURNS
  520.         handle - Handle to a AmigaGuide system.
  521.  
  522.      SEE ALSO
  523.         OpenAmigaGuideAsyncA(), CloseAmigaGuide()
  524.  
  525. amigaguide.library/OpenAmigaGuideAsyncAamigaguide.library/OpenAmigaGuideAsyncA
  526.  
  527.     NAME
  528.         OpenAmigaGuideAsyncA - Open an AmigaGuide database async (V34)
  529.  
  530.     SYNOPSIS
  531.         handle = OpenAmigaGuideAsyncA (nag, attrs);
  532.         d0                            a0   d0
  533.  
  534.         AMIGAGUIDECONTEXT OpenAmigaGuideAsyncA (struct NewAmigaGuide *,
  535.                                                 struct TagItem *);
  536.  
  537.         handle = OpenAmigaGuideAsync (nag, tag1, ...);
  538.  
  539.         AMIGAGUIDECONTEXT OpenAmigaGuideAsyncA (struct NewAmigaGuide *,
  540.                                                 Tag tag1, ...);
  541.  
  542.     FUNCTION
  543.         Opens an AmigaGuide database for ansynchronous use.
  544.  
  545.         The NewAmigaGuide structure, and its pointers, must stay valid until
  546.         an ActiveToolID or ToolStatusID message is received by the calling
  547.         process.
  548.  
  549.         This function actually spawns OpenAmigaGuide() as another process, so,
  550.         for further documentation, refer to the OpenAmigaGuide() function.
  551.  
  552.     INPUTS
  553.         nag     - Pointer to a valid NewAmigaGuide structure.
  554.                   (see OpenAmigaGuide() for documentation on its useage).
  555.  
  556.         attrs   - Additional attributes.  See OpenAmigaGuideA().
  557.  
  558.     RETURNS
  559.         handle  - Handle to an AmigaGuide system.
  560.  
  561.     SEE ALSO
  562.         OpenAmigaGuideA(), CloseAmigaGuide()
  563.  
  564. amigaguide.library/RemoveAmigaGuideHostAamigaguide.library/RemoveAmigaGuideHostA
  565.  
  566.      NAME
  567.         RemoveAmigaGuideHostA - Remove a dynamic node host.     (V34)
  568.  
  569.      SYNOPSIS
  570.         use = RemoveAmigaGuideHostA (key, attrs)
  571.         d0                           a0   a1
  572.  
  573.         LONG RemoveAmigaGuideHostA (AMIGAGUIDEHOST, struct TagItem *);
  574.  
  575.         use = RemoveAmigaGuideHost (key, tag1, ...);
  576.  
  577.         LONG RemoveAmigaGuideHost (AMIGAGUIDEHOST, Tag, ...);
  578.  
  579.      FUNCTION
  580.         This function removes a dynamic node host, that was added by
  581.         AddAmigaGuideHost(), from the system.
  582.  
  583.      INPUTS
  584.         key - Key that was returned by AddAmigaGuideHost().
  585.  
  586.         attrs - Additional attributes.  None are defined at this time.
  587.  
  588.      RETURNS
  589.         use - Number of outstanding clients of this database.  You
  590.             can not exit until use==0.
  591.  
  592.      SEE ALSO
  593.         AddAmigaGuideHostA()
  594.  
  595. amigaguide.library/ReplyAmigaGuideMsg   amigaguide.library/ReplyAmigaGuideMsg
  596.  
  597.     NAME
  598.         ReplyAmigaGuideMsg - Reply to an AmigaGuide message.    (V34)
  599.  
  600.     SYNOPSIS
  601.         ReplyAmigaGuideMsg ( msg );
  602.                              a0
  603.  
  604.         VOID ReplyAmigaGuideMsg (struct AmigaGuideMsg *msg);
  605.  
  606.     FUNCTION
  607.         This function is used to reply to an AmigaGuide SIPC message.
  608.  
  609.     INPUTS
  610.         msg - Pointer to a SIPC message returned by a previous call to
  611.             GetAmigaGuideMsg().
  612.  
  613.     SEE ALSO
  614.         OpenAmigaGuideAsyncA(), AmigaGuideSignal(), GetAmigaGuideMsg()
  615.  
  616. amigaguide.library/SendAmigaGuideCmdA   amigaguide.library/SendAmigaGuideCmdA
  617.  
  618.     NAME
  619.         SendAmigaGuideCmdA - Send a command string to AmigaGuide (V34)
  620.  
  621.     SYNOPSIS
  622.         success = SendAmigaGuideCmdA (handle, cmd, attrs );
  623.         d0                              a0    d0   d1
  624.  
  625.         BOOL SendAmigaGuideCmdA (AMIGAGUIDECONTEXT, STRPTR, struct TagItem *);
  626.  
  627.         success = SendAmigaGuideCmd (handle, cmd, tag1, ...);
  628.  
  629.         BOOL SendAmigaGuideCmd (AMIGAGUIDECONTEXT, STRPTR, Tag);
  630.  
  631.     FUNCTION
  632.         This function sends a command string to an AmigaGuide system.  The
  633.         command can consist of any valid AmigaGuide action command.
  634.  
  635.         The following are the currently valid action commands:
  636.  
  637.         ALINK <name> - Load the named node into a new window.
  638.  
  639.         LINK <name> - Load the named node.
  640.  
  641.         RX <macro> - Execute an ARexx macro.
  642.  
  643.         RXS <cmd> - Execute an ARexx string file.  To display a picture,
  644.             use 'ADDRESS COMMAND DISPLAY <picture name>', to
  645.             display a text file 'ADDRESS COMMAND MORE <doc>'.
  646.  
  647.         CLOSE - Close the window (should only be used on windows
  648.             that were started with ALINK).
  649.  
  650.         QUIT - Shutdown the current database.
  651.  
  652.     INPUTS
  653.         handle - Handle to an AmigaGuide system.
  654.  
  655.         cmd - Command string.
  656.  
  657.         attrs - Future expansion, must be set to NULL for now.
  658.  
  659.     TAGS
  660.         AGA_Context (ULONG) - Data is used as an index into nag_Context
  661.             array.  This is used to build and send a LINK command.
  662.  
  663.     EXAMPLE
  664.  
  665.         /* bring up help on a particular subject */
  666.         SendAmigaGuideCmd(handle, "LINK MAIN", NULL);
  667.  
  668.     RETURNS
  669.         Returns TRUE if the message was sent, otherwise returns FALSE.
  670.  
  671.     BUGS
  672.         ALINK does not open a new window when using V39.
  673.  
  674.     SEE ALSO
  675.  
  676. amigaguide.library/SendAmigaGuideContextAamigaguide.library/SendAmigaGuideContextA
  677.  
  678.     NAME
  679.         SendAmigaGuideContextA - Align an AmigaGuide system on the context ID.
  680.                                                                 (V34)
  681.     SYNOPSIS
  682.         success = SendAmigaGuideContextA (handle, attrs);
  683.         d0                                a0      d0
  684.  
  685.         BOOL SendAmigaGuideContextA (AMIGAGUIDECONTEXT, struct TagItem *);
  686.  
  687.         success = SendAmigaGuideContext (handle, tag1, ...);
  688.  
  689.         BOOL SendAmigaGuideContext (AMIGAGUIDECONTEXT, Tag, ...);
  690.  
  691.     FUNCTION
  692.         This function is used to send a message to an AmigaGuide system to
  693.         align it on the current context ID.
  694.  
  695.         This function effectively does a:
  696.  
  697.             SendAmigaGuideCmd(handle 'LINK ContextArray[contextID]', NULL);
  698.  
  699.     INPUTS
  700.         handle - Handle to an AmigaGuide system.
  701.         future - Future expansion, must be set to NULL for now.
  702.  
  703.     EXAMPLE
  704.  
  705.         struct IntuiMessage *imsg;
  706.  
  707.         ...
  708.  
  709.         case RAWKEY:
  710.             switch (imsg->Code)
  711.             {
  712.                 case 95:
  713.                     /* bring up help on a particular subject */
  714.                     SendAmigaGuideContext(handle, NULL);
  715.                     break;
  716.                 ...
  717.             }
  718.             break;
  719.  
  720.         ...
  721.  
  722.     RETURNS
  723.         success - Returns TRUE if the message was sent, otherwise returns
  724.             FALSE.
  725.  
  726.     SEE ALSO
  727.         SetAmigaGuideContextA(), SendAmigaGuideCmdA()
  728.  
  729. amigaguide.library/SetAmigaGuideAttrsA amigaguide.library/SetAmigaGuideAttrsA
  730.  
  731.      NAME
  732.         SetAmigaGuideAttrsA - Set an AmigaGuide attribute.      (V34)
  733.  
  734.      SYNOPSIS
  735.         retval = SetAmigaGuideAttrsA (handle, attrs);
  736.         d0                            a0      a1
  737.  
  738.         LONG SetAmigaGuideAttrsA (AMIGAGUIDECONTEXT, struct TagItem *);
  739.  
  740.         retval = SetAmigaGuideAttrs (handle, tag1, ...);
  741.  
  742.         LONG SetAmigaGuideAttrs (AMIGAGUIDECONTEXT, Tag, ...);
  743.  
  744.      FUNCTION
  745.         This function is used to set AmigaGuide attributes.
  746.  
  747.      INPUTS
  748.         handle  - Pointer to an AmigaGuide handle.
  749.  
  750.         attrs   - Attribute pairs to set.
  751.  
  752.      TAGS
  753.         AGA_Activate (BOOL) - AmigaGuide activates the window when
  754.             it receives a LINK command.  This tag allows the
  755.             application developer to turn that feature off and on.
  756.  
  757.      SEE ALSO
  758.         GetAmigaGuideAttr()
  759.  
  760. amigaguide.library/SetAmigaGuideContextAamigaguide.library/SetAmigaGuideContextA
  761.  
  762.     NAME
  763.         SetAmigaGuideContextA - Set the context ID for an AmigaGuide system.
  764.                                                                 (V34)
  765.     SYNOPSIS
  766.         success = SetAmigaGuideContextA ( handle, context, attrs );
  767.         d0                               a0         d0       d1
  768.  
  769.         BOOL SetAmigaGuideContextA (AMIGAGUIDECONTEXT, ULONG, struct TagItem *
  770.         );
  771.  
  772.         success = SetAmigaGuideContext (handle, context, tag1, ...);
  773.  
  774.         BOOL SetAmigaGuideContext (AMIGAGUIDECONTEXT, ULONG, Tag, ...);
  775.  
  776.     FUNCTION
  777.         This function, and the SendAmigaGuideContext() function, are used to
  778.         provide a simple way to display a node based on a numeric value,
  779.         instead of having to build up a slightly more complex command
  780.         string.
  781.  
  782.     INPUTS
  783.         handle  - Handle to an AmigaGuide system.
  784.  
  785.         context - Index value of the desired node to display.
  786.  
  787.         future  - Future expansion, must be set to NULL for now.
  788.  
  789.     EXAMPLE
  790.  
  791.         /* sample context table */
  792.         STRPTR ContextArray[] =
  793.         {
  794.             "MAIN",
  795.             "FILEREQ",
  796.             "PRINT",
  797.             "ABOUT",
  798.             NULL
  799.         };
  800.  
  801.         /* quickie defines */
  802.         #define HELP_MAIN       0
  803.         #define HELP_FILEREQ    1
  804.         #define HELP_PRINT      2
  805.         #define HELP_ABOUT      3
  806.  
  807.         ...
  808.  
  809.         struct NewAmigaGuide nag = {NULL};
  810.  
  811.         /* initialize the context table */
  812.         nag.nag_Context = ContextArray;
  813.  
  814.         ...
  815.  
  816.         /* bring up help on a particular subject */
  817.         SetAmigaGuideContext(handle, HELP_ABOUT, NULL);
  818.  
  819.     RETURNS
  820.         success - Returns TRUE if a valid context ID was passed,
  821.             otherwise returns FALSE.
  822.  
  823.     SEE ALSO
  824.         SendAmigaGuideContextA(), SendAmigaGuideCmdA()
  825.  
  826. amigaguide.library/UnlockAmigaGuideBaseamigaguide.library/UnlockAmigaGuideBase
  827.  
  828.      NAME
  829.         UnlockAmigaGuideBase - Unlock an AmigaGuide client.     (V34)
  830.  
  831.      SYNOPSIS
  832.         UnlockAmigaGuideBase (key);
  833.                               d0
  834.  
  835.         VOID UnlockAmigaGuideBase (LONG);
  836.  
  837.      FUNCTION
  838.         This function is used to release a lock obtained with
  839.         LockAmigaGuideBase().
  840.  
  841.      INPUTS
  842.         key - Value returned by LockAmigaGuideBase().
  843.  
  844.      SEE ALSO
  845.         LockAmigaGuideBase().
  846.  
  847.