a1200   NEWS   APPS   DOCS   ABOUT
a1200
----
a1200
----
Autodocs
 Libraries:
 amigaguide.library
  --background--
  --rexxhost--
  AddAmigaGuideHostA
  AmigaGuideSignal
  CloseAmigaGuide
  GetAmigaGuideAttr
  GetAmigaGuideMsg
  GetAmigaGuideString
  LockAmigaGuideBase
  OpenAmigaGuideA
  OpenAmigaGuideAsyncA
  RemoveAmigaGuideHostA
  ReplyAmigaGuideMsg
  SendAmigaGuideCmdA
  SendAmigaGuideContextA
  SetAmigaGuideAttrsA
  SetAmigaGuideContextA
  UnlockAmigaGuideBase
Include
GuruMeditation
Docs » Autodocs » amigaguide.library » AddAmigaGuideHostA

NAME

        AddAmigaGuideHostA - Add a dynamic node host.           (V34)

SYNOPSIS

        handle = AddAmigaGuideHostA (hook, name, attrs);
d0 a0 d0 a1
AMIGAGUIDEHOST AddAmigaGuideHostA (struct Hook *, STRPTR,
struct TagItem *);

FUNCTION

        This function adds a callback hook to the dynamic node list.
A dynamic node allows an application to incorporate context-
sensitive or live project data within their help system.

INPUTS

        hook - The callback hook.
name - Name of the AmigaGuideHost database that you are adding.
The name must be unique.
attrs - Additional attributes. None are defined at this time.

RESULT

        Returns NULL if unable to add the dynamic node host, otherwise
returns a pointer to a handle that will eventually be passed
to RemoveAmigaGuideHost() to remove the dynamic node host from
the list.

NOTES

        When AmigaGuide attempts to resolve a LINK command, it performs
the following sequence of events.
Splits the name into a path, a database and a node (only
the node is required).
Opens the database.
Performs the following searches until the node is found:
Search the local database.
Search the local cross reference list.
Search the local dynamic node host.
Search the global help file (system help).
Search the global cross reference list.
Search the global dynamic node hosts.

SEE ALSO

RemoveAmigaGuideHostA()

EXAMPLE

        /* Hook dispatcher */
ULONG __asm hookEntry(
register __a0 struct Hook *h,
register __a2 VOID *obj,
register __a1 VOID *msg)
{
/* Pass the parameters on the stack */
return ((h->h_SubEntry)(h, obj, msg));
}
ULONG __saveds
dispatchAmigaGuideHost (struct Hook *h, STRPTR db, Msg msg)
{
struct opNodeIO *onm = (struct opNodeIO *) msg;
ULONG retval = 0;
switch (msg->MethodID)
{
/* Does this node belong to you? */
case HM_FINDNODE:
{
struct opFindHost *ofh = (struct opFindHost *) msg;
kprintf("Find [%s] in %s\n", ofh->ofh_Node, db);
/* Return TRUE to indicate that it's your node,
* otherwise return FALSE. */
retval = TRUE;
}
break;
/* Open a node. */
case HM_OPENNODE:
kprintf("Open [%s] in %s\n", onm->onm_Node, db);
/* Provide the contents of the node */
onm->onm_DocBuffer = TEMP_NODE;
onm->onm_BuffLen = strlen(TEMP_NODE);
/* Indicate that we were able to open the node */
retval = TRUE;
break;
/* Close a node, that has no users. */
case HM_CLOSENODE:
kprintf("Close [%s] in %s\n", onm->onm_Node, db);
/* Indicate that we were able to close the node */
retval = TRUE;
break;
/* Free any extra memory */
case HM_EXPUNGE:
kprintf("Expunge [%s]\n", db);
break;
default:
kprintf("Unknown method %ld\n", msg->MethodID);
break;
}
return (retval);
}
main(int argc, char **argv)
{
struct Hook hook;
AMIGAGUIDEHOST hh;
/* Open the library */
if (AmigaGuideBase = OpenLibrary("amigaguide.library", 33))
{
/* Initialize the hook */
hook.h_Entry = hookEntry;
hook.h_SubEntry = dispatchAmigaGuideHost;
/* Add the AmigaGuideHost to the system */
if (hh = AddAmigaGuideHost(&hook, "ExampleHost", NULL))
{
/* Wait until we're told to quit */
Wait(SIGBREAKF_CTRL_C);
/* Try removing the host */
while (RemoveAmigaGuideHost(hh, NULL) > 0)
{
/* Wait a while */
Delay(5);
}
}
/* close the library */
CloseLibrary(AmigaGuideBase);
}
}

BUGS

        When a dynamic node host is first added it will receive a
HM_FINDNODE message with an onm_Node of "Main". The
AGA_HelpGroup attribute will always be zero for this
particular message.

Comments

Name:
E-mail: Use this if you want a message if you get a response, will not be shown.
Comment:
Select correct short for:

Paradox

AYS
PDX
DC
CSL

Comments:

$VER: d0.se 1.14 Copyright © 2011-2020 Tobias Geijersson support at d0 dot se