home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Workbench / Libs / GADUTIL.LHA / GadUtil / Docs / AutoDocs / 05.GU_GetIMsg < prev    next >
Encoding:
Text File  |  1995-06-17  |  1.7 KB  |  49 lines
  1. gadutil.library/GU_GetIMsg                         gadutil.library/GU_GetIMsg
  2.  
  3.    NAME
  4.     GU_GetIMsg -- Get an IntuiMessage, process GadTools & Hotkey events.
  5.  
  6.    SYNOPSIS
  7.     imsg = GU_GetIMsg(intuiport)
  8.     D0,A0,SR(Z)       A0
  9.  
  10.     struct IntuiMessage *GU_GetIMsg(struct MsgPort *);
  11.  
  12.    FUNCTION
  13.     Use GU_GetIMsg() in place of the usual exec.library/GetMsg() when
  14.     reading IntuiMessages from your window's UserPort. If needed, the
  15.     GadTools dispatcher will be invoked, and suitable processing will
  16.     be done for gadget actions.
  17.     If the message is an IDCMP_VANILLAKEY or an IDCMP_RAWKEY, this
  18.     routine will search through all gadgets    for that key, and if it is
  19.     found, the message will change to the type of message that gadget
  20.     is supposed to send. If the key is not used as a hotkey, the
  21.     message will not change. 
  22.     If there are no messages (or if the only messages are meaningful
  23.     only to GadTools/GadUtil), NULL will be returned.
  24.  
  25.    INPUTS
  26.     intuiport - the Window->UserPort of a window that is using the
  27.         GadUtil library.
  28.  
  29.    RESULT
  30.     imsg - pointer to modified IntuiMessage, or NULL if there are
  31.            no applicable messages.
  32.  
  33.     SR (Z) - the zero flag will be set if there was no message. This
  34.            is probably only useful for assembly language programmers.
  35.  
  36.    NOTES
  37.     Be sure to use GU_ReplyIMsg() and not exec.library/ReplyMsg() on
  38.     messages obtained with GU_GetIMsg().
  39.     If you intend to do more with the resulting message than read its
  40.     fields, act on it, and reply it, you may find GU_FilterIMsg()
  41.     more appropriate.
  42.  
  43.     Starting with V39 (of the OS), this function actually returns a
  44.     pointer to an ExtIntuiMessage structure, but the prototype was
  45.     not changed for source code compatibility with older software.
  46.  
  47.    SEE ALSO
  48.     GU_ReplyIMsg(), GU_FilterIMsg()
  49.