dtactiondescription(3) [hpux man page]

DtActionDescription(library call)										 DtActionDescription(library call)

NAME

       DtActionDescription -- obtain the descriptive text for a given action

SYNOPSIS

       #include <Dt/Action.h>
       char *DtActionDescription(
       char *actionName);

DESCRIPTION

       The  DtActionDescription function looks up and returns the descriptive text associated with the actionName action.  The actionName argument
       is the name of the action.  If there are multiple actionName actions, the string returned is the description of the most general.  The most
       general action is the one with the lowest precedence, as described in dtactionfile(4) (``Action Selection'').

RETURN VALUE

       Upon  successful  completion, the DtActionDescription function returns a newly allocated copy of the description string associated with the
       action; otherwise, it returns NULL.

APPLICATION USAGE

       The DtActionDescription function is useful for applications that wish to present information to the user about a particular action.

       The application should use XtFree(3) to free the description string returned by DtActionDescription.

SEE ALSO

       Dt/Action.h - DtAction(5), XtFree(3), dtactionfile(4), dtdtfile(4).

														 DtActionDescription(library call)

Dt/Action.h(file formats)												 Dt/Action.h(file formats)

NAME

       Dt/Action.h -- action service definitions

SYNOPSIS

       #include <Dt/Action.h>

DESCRIPTION

       The Dt/Action.h header defines the following DtActionStatus constants:

       DtACTION_OK
       DtACTION_INVALID_ID
       DtACTION_INVOKED
       DtACTION_DONE
       DtACTION_CANCELED
       DtACTION_FAILED
       DtACTION_STATUS_UPDATE

       The header defines the following data type through typedef:

       typedef unsigned long DtActionInvocationID;

       The header defines the following callback prototypes:

       typedef void (*DtActionCallbackProc)(DtActionInvocationID id,
	       XtPointer client_data,
	       DtActionArg *args,
	       int argCount,
	       DtActionStatus status);

       typedef void (*DtDbReloadCallbackProc)(XtPointer clientData);

       The header defines the following as functions:

       void DtDbReloadNotify(DtDbReloadCallbackProc proc,
	       XtPointer clientData);

       void DtDbLoad(void);

       Boolean DtActionExists(char *s);

       char *DtActionLabel(char *s);

       char *DtActionDescription(char *actionName);

       char *DtActionIcon(char *actionName);

       DtActionInvocationID
       DtActionInvoke(Widget w,
	       char *action,
	       DtActionFile *args,
	       int argCount,
	       char *termOpts,
	       char *execHost,
	       char *contextDir,
	       int useIndicator,
	       DtActionCallbackProc statusUpdateCb,
	       XtPointer client_data);

SEE ALSO

       DtActionDescription(3), DtActionExists(3), DtActionIcon(3), DtActionInvoke(3), DtActionLabel(3), DtActionCallbackProc(3), DtDbLoad(3), DtD-
       bReloadNotify(3), dtaction(1).

															 Dt/Action.h(file formats)