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


   NAME
        GT_GetIMsg -- get an intuimessage, with gadtools processing. (v36)

   SYNOPSIS
        imsg = GT_GetIMsg(intuiport)
        D0                A0

        struct intuimessage *gt_getimsg(struct msgport *);

   FUNCTION
        Use GT_GetIMsg() in place of the usual exec.library/getmsg() when
        reading IntuiMessages from your window's UserPort.  If needed,
        the GadTools dispatcher will be invoked, and suitable processing
        will be done for gadget actions.  This function returns a pointer
        to a modified intuimessage (which is a copy of the original,
        possibly with some supplementary information from GadTools).
        If there are no messages (or if the only messages are meaningful
        only to GadTools, NULL will be returned.

   INPUTS
        intuiport - the Window->UserPort of a window that is using the
                    gadget toolkit.

   RESULT
        imsg - pointer to modified intuimessage, or null if there are
               no applicable messages.

   NOTES
        Be sure to use gt_replyimsg() and not exec.library/replymsg() on
        messages obtained with GT_GetIMsg().
        If you intend to do more with the resulting message than read
        its fields, act on it, and reply it, you may find gt_filterimsg()
        more appropriate.

        Starting with V39, this function actually returns a pointer to an
        extintuimessage structure, but the prototype was not changed for
        source code compatibility with older software.

   SEE ALSO
        gt_replyimsg(), gt_filterimsg()