home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / dev / gui / mui / developer / autodocs / muimaster.doc < prev   
Text File  |  1994-08-08  |  19KB  |  638 lines
  1. TABLE OF CONTENTS
  2.  
  3. muimaster.library/--background--
  4. muimaster.library/MUI_AllocAslRequest
  5. muimaster.library/MUI_AslRequest
  6. muimaster.library/MUI_CreateCustomClass
  7. muimaster.library/MUI_DeleteCustomClass
  8. muimaster.library/MUI_DisposeObject
  9. muimaster.library/MUI_Error
  10. muimaster.library/MUI_FreeAslRequest
  11. muimaster.library/MUI_FreeClass
  12. muimaster.library/MUI_GetClass
  13. muimaster.library/MUI_MakeObjectA
  14. muimaster.library/MUI_NewObjectA
  15. muimaster.library/MUI_Redraw
  16. muimaster.library/MUI_RequestA
  17. muimaster.library/MUI_RejectIDCMP
  18. muimaster.library/MUI_RequestIDCMP
  19. muimaster.library/MUI_SetError
  20.  
  21.  
  22. muimaster.library/--background--             muimaster.library/--background--
  23.  
  24.     PURPOSE
  25.     muimaster.library contains functions for creating and diposing
  26.     objects, for requester handling and for controlling custom
  27.     classes. Additionally, several of the standard MUI classes are
  28.     built into muimaster.library. For you as a programmer, there
  29.     is no difference between using a builtin class or an external
  30.     class coming as "sys:classes/<foobar>.mui". The MUI object
  31.     generation call takes care of this situation and loads
  32.     external classes automatically when they are needed.
  33.  
  34.  
  35. muimaster.library/MUI_AllocAslRequest   muimaster.library/MUI_AllocAslRequest
  36.  
  37.     NAME
  38.     MUI_AllocAslRequest
  39.  
  40.     FUNCTION
  41.     Provide an interface to asl.library. Using this ensures
  42.     your application will benefit from future expansions
  43.         to MUI's window and iconification handling.
  44.  
  45.     SEE ALSO
  46.     asl.library/AllocAslRequest
  47.  
  48.  
  49. muimaster.library/MUI_AslRequest
  50.  
  51.     NAME
  52.     MUI_AslRequest
  53.  
  54.     FUNCTION
  55.     Provide an interface to asl.library. Using this ensures
  56.     your application will benefit from future expansions
  57.         to MUI's window and iconification handling.
  58.  
  59.     SEE ALSO
  60.     asl.library/AslRequest
  61.  
  62.  
  63. muimaster.library/MUI_CreateCustomClass                 MUI_CreateCustomClass
  64.  
  65.     NAME
  66.     MUI_CreateCustomClass -- create a public/private custom class.
  67.  
  68.     SYNOPSIS
  69.     MUI_CreateCustomClass (base, supername, supermcc, datasize, dispfunc)
  70.                             A0    A1        A2        D0        A3
  71.  
  72.     struct MUI_CustomClass * MUI_CreateCustomClass(
  73.        struct Library *, char *, int, APTR );
  74.  
  75.     FUNCTION
  76.     This function creates a public or private MUI custom class.
  77.     Public custom classes are shared libraries and can be found
  78.     in "libs:mui/<foobar>.mcc". Private classes simply consist
  79.     of a dispatcher and are built into applications.
  80.  
  81.     MUI_CreateCustomClass() returns a pointer to a struct
  82.     MUI_CustomClass which in turn contains a pointer to a
  83.     struct IClass. For private classes, this struct IClass
  84.     pointer needs to be fed to a intuition.library/NewObject()
  85.     call to create new objects.
  86.  
  87.     MUI creates the dispatcher hook for you, you may *not*
  88.     use the IClass->cl_Dispatcher.h_Data field! If you need
  89.     custom data for your dispatcher, use the cl_UserData
  90.     of the IClass structure or the mcc_UserData of the
  91.     MUI_CustomClass structure.
  92.  
  93.     For public classes, MUI makes sure that a6 contains
  94.     a pointer to your library base when your dispatcher
  95.     is called. For private classes, you will need to keep
  96.     track of A4 of similiar things your compiler may
  97.     need yourself.
  98.  
  99.     INPUTS
  100.     base =      if you create a public class, you have to call
  101.                 MUI_CreateCustomClass() from your libraries
  102.                 init function. In this case, place your library
  103.                 base pointer here. For private classes, you must
  104.                 supply NULL.
  105.  
  106.     supername = super class of your class. This can either
  107.                 be a builtin MUI class ("xyz.mui") or a external
  108.                 custom class ("xyz.mcc").
  109.  
  110.     supermcc =  if (and only if) the super class is a private
  111.                 custom class and hence has no name, you are allowed
  112.                 to pass a NULL supername and a pointer to the
  113.                 MUI_CustomClass structure of the super class here.
  114.  
  115.     datasize =  size of your classes data structure.
  116.  
  117.     dispfunc =  your classes dispatcher function (no hook!).
  118.                 The dispatcher will be called with a struct IClass
  119.                 in a0, with your object in a2 and the message in a1.
  120.  
  121.     RESULT
  122.     A pointer to a struct MUI_CustomClass or NULL to indicate
  123.     an error.
  124.  
  125.     SEE ALSO
  126.     MUI_DeleteCustomClass()
  127.  
  128.  
  129. muimaster.library/MUI_DeleteCustomClass                 MUI_DeleteCustomClass
  130.  
  131.     NAME
  132.     MUI_DeleteCustomClass -- delete a public/private custom class.
  133.  
  134.     SYNOPSIS
  135.     MUI_DeleteCustomClass ( mcc )
  136.                             A0
  137.  
  138.     BOOL MUI_DeleteCustomClass(struct MUI_CustomClass *);
  139.  
  140.     FUNCTION
  141.     Delete a public or private custom class. Note that you
  142.     must not delete classes with outstanding objects or sub
  143.     classes.
  144.  
  145.     INPUTS
  146.     mcc = pointer obtained from MUI_CreateCustomClass().
  147.  
  148.     RESULT
  149.     TRUE if all went well, FALSE if some objects or
  150.     sub classes were still hanging around. Nothing
  151.     will be freed in this case.
  152.  
  153.     SEE ALSO
  154.     MUI_CreateCustomClass()
  155.  
  156.  
  157. muimaster.library/MUI_DisposeObject       muimaster.library/MUI_DisposeObject
  158.  
  159.     NAME
  160.     MUI_DisposeObject -- Delete a MUI object.
  161.  
  162.     SYNOPSIS
  163.     MUI_DisposeObject( object )
  164.                        A0
  165.  
  166.     VOID MUI_DisposeObject( APTR );
  167.  
  168.     FUNCTION
  169.     Deletes a MUI object and all of it's auxiliary data.
  170.     These objects are all created by MUI_NewObject(). Objects
  171.     of certain classes "own" other objects, which will also
  172.     be deleted when the object is passed to MUI_DisposeObject().
  173.     Read the per-class documentation carefully to be aware
  174.     of these instances.
  175.  
  176.     INPUTS
  177.     object = abstract pointer to a MUI object returned by
  178.              MUI_NewObject(). The pointer may be NULL, in which case
  179.              this function has no effect.
  180.  
  181.     RESULT
  182.     None.
  183.  
  184.     SEE ALSO
  185.     MUI_NewObject(), SetAttrs(), GetAttr().
  186.  
  187.  
  188. muimaster.library/MUI_Error                       muimaster.library/MUI_Error
  189.  
  190.     NAME
  191.     MUI_Error -- Return extra information from the MUI system.
  192.  
  193.     SYNOPSIS
  194.     LONG MUI_Error(VOID);
  195.  
  196.     FUNCTION
  197.     Some MUI functions will set an error if they fail for
  198.     some reason. The error functions is task sensitive,
  199.     only the task that caused the error will receive it
  200.     from this function.
  201.  
  202.     RESULT
  203.     Currently, the following error values are defined:
  204.  
  205.     MUIE_OK                  - no error, everything allright.
  206.     MUIE_OutOfMemory         - went out of memory.
  207.     MUIE_OutOfGfxMemory      - went out of graphics memory.
  208.     MUIE_InvalidWindowObject - NULL window specified.
  209.     MUIE_MissingLibrary      - can't open a needed library.
  210.     MUIE_NoARexx             - unable to create arexx port.
  211.     MUIE_SingleTask          - application is already running.
  212.  
  213.     SEE ALSO
  214.     MUI_SetError()
  215.  
  216.  
  217. muimaster.library/MUI_FreeAslRequest     muimaster.library/MUI_FreeAslRequest
  218.  
  219.     NAME
  220.     MUI_FreeAslRequest
  221.  
  222.     FUNCTION
  223.     Provide an interface to asl.library. Using this ensures
  224.     your application will benefit from future expansions
  225.         to MUI's window and iconification handling.
  226.  
  227.     SEE ALSO
  228.     asl.library/FreeAslRequest
  229.  
  230.  
  231. muimaster.library/MUI_FreeClass               muimaster.library/MUI_FreeClass
  232.  
  233.     NAME
  234.      MUI_FreeClass -- Free class.
  235.  
  236.     SYNOPSIS
  237.     MUI_FreeClass( classptr )
  238.                    A0
  239.  
  240.     VOID MUI_FreeClass(struct IClass *classptr);
  241.  
  242.     FUNCTION
  243.     This function is obsolete since MUI V8.
  244.     Use MUI_DeleteCustomClass() instead.
  245.  
  246.     SEE ALSO
  247.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  248.  
  249.  
  250. muimaster.library/MUI_GetClass                 muimaster.library/MUI_GetClass
  251.  
  252.     NAME
  253.      MUI_GetClass -- Get a pointer to a MUI class.
  254.  
  255.     SYNOPSIS
  256.     class = MUI_GetClass( classid )
  257.     D0                    A0
  258.  
  259.     struct IClass * MUI_GetClass(char *classid);
  260.  
  261.     FUNCTION
  262.     This function is obsolete since MUI V8.
  263.     Use MUI_CreateCustomClass instead.
  264.  
  265.     SEE ALSO
  266.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  267.  
  268.  
  269. muimaster.library/MUI_MakeObjectA           muimaster.library/MUI_MakeObjectA
  270.  
  271.     NAME
  272.      MUI_MakeObjectA -- create an object from the builtin object collection.
  273.      MUI_MakeObject -- Varargs stub for MUI_MakeObjectA
  274.  
  275.     SYNOPSIS
  276.     object = MUI_MakeObjectA( objtype, params )
  277.     D0                        D0       A0
  278.  
  279.     Object * MUI_MakeObjectA(ULONG type, ULONG *params);
  280.  
  281.     Object * MUI_MakeObject(ULONG type, ...);
  282.  
  283.     FUNCTION
  284.     Prior to muimaster.library V8, MUI was distributed with several macros
  285.     to help creating often used objects. This practice was easy, but using
  286.     lots of these macros often resulted in big programs. Now, muimaster
  287.     library contains an object library with several often used objects
  288.     already built in.
  289.  
  290.     MUI_MakeObject() takes the type of the object as first parameter and
  291.     a list of additional (type specific) parameters. Note that these
  292.     additional values are *not* a taglist!
  293.  
  294.     See the header file mui.h for documentation on object types and the
  295.     required parameters.
  296.  
  297.     SEE ALSO
  298.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  299.  
  300.  
  301. muimaster.library/MUI_NewObjectA             muimaster.library/MUI_NewObjectA
  302.  
  303.    NAME
  304.     MUI_NewObjectA -- Create an object from a class.
  305.     MUI_NewObject -- Varargs stub for MUI_NewObjectA().
  306.  
  307.    SYNOPSIS
  308.     object = MUI_NewObjectA( class, tags )
  309.     D0                       A0     A1
  310.  
  311.     APTR MUI_NewObjectA( char *, struct TagItem * );
  312.  
  313.     object = MUI_NewObject( classID, Tag1, ... )
  314.  
  315.     APTR MUI_NewObject( classID, ULONG, ... );
  316.  
  317.    FUNCTION
  318.     This is the general method of creating objects from MUI classes.
  319.     You specify a class by its ID string. If the class is not
  320.     already in memory or built into muimaster.library, it will be
  321.     loaded using OpenLibrary("mui/%s",0).
  322.  
  323.     You further specify initial "create-time" attributes for the
  324.     object via a TagItem list, and they are applied to the resulting
  325.     generic data object that is returned. The attributes, their meanings,
  326.     attributes applied only at create-time, and required attributes
  327.     are all defined and documented on a class-by-class basis.
  328.  
  329.    INPUTS
  330.     classID = the name/ID string of a MUI class, e.g. "Image.mui".
  331.               Class names are case sensitive!
  332.  
  333.     tagList = pointer to array of TagItems containing attribute/value
  334.               pairs to be applied to the object being created.
  335.  
  336.    RESULT
  337.     A MUI object, which may be used in different contexts such
  338.     as an application, window or gadget, and may be manipulated
  339.     by generic functions. You eventually free the object using
  340.     MUI_DisposeObject().
  341.     NULL indicates failure, more information on the error can be
  342.     obtained with MUI_Error().
  343.  
  344.    BUGS
  345.  
  346.    SEE ALSO
  347.     MUI_DisposeObject(), MUI_Error(), SetAttrs(), GetAttr().
  348.  
  349.  
  350. muimaster.library/MUI_Redraw                     muimaster.library/MUI_Redraw
  351.  
  352.    NAME
  353.     MUI_Redraw -- Redraw yourself.
  354.  
  355.    SYNOPSIS
  356.     MUI_Redraw( obj, flag )
  357.                 A0   D0
  358.  
  359.     VOID MUI_Redraw( Object *obj, ULONG flag );
  360.  
  361.    FUNCTION
  362.     With MUI_Redraw(), an object tells itself to refresh, e.g. when
  363.     some internal attributes were changed. Calling MUI_Redraw() is
  364.     only legal within a custom class dispatcher, using this function
  365.     within an applications main part is invalid!
  366.  
  367.     Most objects graphical representation in a window depends on some
  368.     attributes. A fuel gauge for example would depend on its
  369.     MUIA_Gauge_Current attribute, an animation object would
  370.     depend on MUIA_Animation_CurrentFrame.
  371.  
  372.     Whenever someone changes such an attribute with a SetAttrs() call,
  373.     the corresponding object receives an OM_SET method with the new
  374.     value. Usually, it could just render itself with some
  375.     graphics.library calls. However, if the object is placed
  376.     in a virtual group or if some other clipping or coordinate
  377.     translation is required, this simple rendering will lead
  378.     into problems.
  379.  
  380.     That's why MUI offers the MUI_Redraw() function call. Instead
  381.     of drawing directly during OM_SET, you should simply call
  382.     MUI_Redraw(). MUI calculates all necessary coordinates
  383.     and clip regions (in case of virtual groups) and then sends
  384.     a MUIM_Draw method to your object.
  385.  
  386.     To emphasize this point again: The only time your object is
  387.     allowed to render something is when you receive a MUIM_Draw
  388.     method. Drawing during other methods is illegal.
  389.  
  390.     Note: As long as no special cases (e.g. virtual groups) are
  391.           present, MUI_Redraw is very quick and calls your MUIM_Draw
  392.           method immediately. No coordinate translations or clip
  393.           regions need to be calculated.
  394.  
  395.    INPUTS
  396.     obj  - pointer to yourself.
  397.     flag - MADF_DRAWOBJECT or MADF_DRAWUPDATE.
  398.            The flag given here affects the objects flags when
  399.            MUI calls the MUIM_Draw method. There are several
  400.            caveats when implementing MUIM_DRAW, see the
  401.            developer documentation for details.
  402.  
  403.    EXAMPLE
  404.  
  405.     /* Note: This example was broken up to version 2.1 of muimaster.doc */
  406.  
  407.     LONG mSet(struct IClass *cl,Object *obj,sruct opSet *msg)
  408.     {
  409.        struct Data *data = INST_DATA(cl,obj);
  410.        struct TagItem *tags,*tag;
  411.  
  412.        for (tags=msg->ops_AttrList;tag=NextTagItem(&tags);)
  413.        {
  414.           switch (tag->ti_Tag)
  415.           {
  416.              case MYATTR_PEN_1:
  417.                 data->pen1 = tag->ti_Data;       /* set the new value  */
  418.                 data->mark = 1;                  /* set internal marker*/
  419.                 MUI_Redraw(obj,MADF_DRAWUPDATE); /* update ourselves   */
  420.                 break;
  421.  
  422.              case MYATTR_PEN_1:
  423.                 data->pen2 = tag->ti_Data;       /* set the new value  */
  424.                 data->mark = 2;                  /* set internal marker*/
  425.                 MUI_Redraw(obj,MADF_DRAWUPDATE); /* update ourselves   */
  426.                 break;
  427.           }
  428.        }
  429.  
  430.        return(DoSuperMethodA(cl,obj,msg));
  431.     }
  432.  
  433.     LONG mDraw(struct IClass *cl,Object *obj,struct MUIP_Draw *msg)
  434.     {
  435.        struct Data *data = INST_DATA(cl,obj);
  436.  
  437.        // ** Note: You *must* call the super method prior to do
  438.        // ** anything else, otherwise msg->flags will not be set
  439.        // ** properly !!!
  440.  
  441.        DoSuperMethodA(cl,obj,msg); // ALWAYS REQUIRED!
  442.  
  443.        if (msg->flags & MADF_DRAWUPDATE)
  444.        {
  445.           /* called as a result of our MUI_Redraw() during
  446.              MUIM_Set method. Depending on our internal
  447.              marker, we render different things. */
  448.  
  449.           switch (data->mark)
  450.           {
  451.              case 1: RenderChangesFromPen1(cl,obj); break;
  452.              case 2: RenderChangesFromPen2(cl,obj); break;
  453.           }
  454.        }
  455.        else if (msg->flags & MADF_DRAWOBJECT)
  456.        {
  457.           /* complete redraw, maybe the window was just opened. */
  458.           DrawObjectCompletely(cl,obj);
  459.        }
  460.  
  461.        /* if MADF_DRAWOBJECT wasn't set, MUI just wanted to update
  462.           the frame or some other part of our object. In this case
  463.           we just do nothing. */
  464.  
  465.         return(0);
  466.     }
  467.  
  468.    SEE ALSO
  469.     area.mui/MUIM_Draw
  470.  
  471.  
  472. muimaster.library/MUI_RequestA                 muimaster.library/MUI_RequestA
  473.  
  474.    NAME
  475.     MUI_RequestA  -- Pop up a MUI requester.
  476.  
  477.    SYNOPSIS
  478.     MUI_RequestA(app,win,flags,title,gadgets,format,params)
  479.                  D0   D1  D2    A0     A1      A2     A3
  480.  
  481.     LONG MUI_RequestA ( APTR app, APTR win, LONGBITS flags,
  482.          char *title, char *gadgets, char *format, APTR params );
  483.  
  484.     LONG MUI_Request ( APTR app, APTR win, LONGBITS flags,
  485.          char *title, char *gadgets, char *format, ...);
  486.  
  487.    FUNCTION
  488.     Pop up a MUI requester. Using a MUI requester instead
  489.     of a standard system requester offers you the possibility
  490.     to include text containing all the text engine format codes.
  491.  
  492.    INPUTS
  493.     app     - The application object. If you leave this
  494.               NULL, MUI_RequestA() will fall back to a
  495.               standard system requester.
  496.  
  497.     win     - Pointer to a window of the application. If
  498.               this is used, the requester will appear centered
  499.               relative to this window.
  500.  
  501.     flags   - For future expansion, must be 0 for now.
  502.  
  503.     title   - Title for the requester window. Defaults to the
  504.               name of the application when NULL (and app!=NULL).
  505.  
  506.     gadgets - Pointer to a string containing the possible answers.
  507.               The format looks like "_Save|_Use|_Test|_Cancel".
  508.               If you precede an entry with a '*', this answer will
  509.               become the active object. Pressing <Return> will
  510.               terminate the requester with this response. A '_'
  511.               character indicates the keyboard shortcut for this
  512.               response.
  513.  
  514.     format  - A printf-style formatting string.
  515.  
  516.     params  - Pointer to an array of ULONG containing the parameter
  517.               values for format.
  518.  
  519.    RESULT
  520.     0, 1, ..., N = Successive id values, for the gadgets
  521.     you specify for the requester.  NOTE: The numbering
  522.     from left to right is actually: 1, 2, ..., N, 0.
  523.     In case of a problem (e.g. out of memory), the
  524.     function returns FALSE.
  525.  
  526.    SEE ALSO
  527.     MUIA_Text_Contents
  528.  
  529.  
  530. muimaster.library/MUI_RejectIDCMP           muimaster.library/MUI_RejectIDCMP
  531.  
  532.    NAME
  533.      MUI_RejectIDCMP -- Reject previously requested input events.
  534.  
  535.    SYNOPSIS
  536.     MUI_RejectIDCMP( obj, flags )
  537.                       A0   D0
  538.  
  539.     VOID MUI_RejectIDCMP( Object *obj, ULONG flags );
  540.  
  541.    FUNCTION
  542.     Reject previously requested input events. You should
  543.     ensure that you reject all input events you requested
  544.     for an object before it gets disposed. Rejecting
  545.     flags that you never requested has no effect.
  546.  
  547.     Critical flags such as IDCMP_MOUSEMOVE and IDCMP_INTUITICKS
  548.     should be rejected as soon as possible. See MUI_RequestIDCMP()
  549.     for details.
  550.  
  551.    INPUTS
  552.     obj   - pointer to yourself as an object.
  553.     flags - one or more IDCMP_XXXX flags.
  554.  
  555.    EXAMPLE
  556.     LONG CleanupMethod(struct IClass *cl, Object *obj, Msg msg)
  557.     {
  558.        MUI_RejectIDCMP( obj, IDCMP_MOUSEBUTTONS|IDCMP_RAWKEY );
  559.        return(DoSuperMethodA(cl,obj,msg));
  560.     }
  561.  
  562.    SEE ALSO
  563.     MUI_RequestIDMCP()
  564.  
  565.  
  566. muimaster.library/MUI_RequestIDCMP         muimaster.library/MUI_RequestIDCMP
  567.  
  568.    NAME
  569.      MUI_RequestIDCMP -- Request input events for your custom class.
  570.  
  571.    SYNOPSIS
  572.     MUI_RequestIDCMP( obj, flags )
  573.                       A0   D0
  574.  
  575.     VOID MUI_RequestIDCMP( Object *obj, ULONG flags );
  576.  
  577.    FUNCTION
  578.     If your custom class needs to do some input handling, you must
  579.     explicitly request the events you want to receive. You can
  580.     request (and reject) events at any time.
  581.  
  582.     Whenever an input event you requested arrives at your parent
  583.     windows message port, your object will receive a
  584.     MUIM_HandleInput method.
  585.  
  586.     Note: Time consuming IDCMP flags such as IDCMP_INTUITICKS and
  587.           IDCMP_MOUSEMOVE should be handled with care. Too many
  588.           objects receiving them will degrade performance With
  589.           the following paragraph in mind, this isn't really
  590.           a problem:
  591.  
  592.           You should try to request critical events only when you
  593.           really need them and reject them with MUI_RejectIDCMP()
  594.           as soon as possible. Usually, mouse controlled objects
  595.           only need MOUSEMOVES and INTUITICKS when a button
  596.           is pressed. You should request these flags only
  597.           on demand, i.e. after receiving a mouse down event
  598.           and reject them immediately after the button has been
  599.           released.
  600.  
  601.    INPUTS
  602.     obj   - pointer to yourself as an object.
  603.     flags - one or more IDCMP_XXXX flags.
  604.  
  605.    EXAMPLE
  606.     LONG SetupMethod(struct IClass *cl, Object *obj, Msg msg)
  607.     {
  608.        if (!DoSuperMethodA(cl,obj,msg))
  609.           return(FALSE);
  610.  
  611.        /* do some setup here... */
  612.        ...;
  613.  
  614.        /* i need mousebutton events and keyboard */
  615.        MUI_RequestIDCMP( obj, IDCMP_MOUSEBUTTONS|IDCMP_RAWKEY );
  616.  
  617.        return(TRUE);
  618.     }
  619.  
  620.    SEE ALSO
  621.     MUI_RejectIDMCP()
  622.  
  623.  
  624. muimaster.library/MUI_SetError                 muimaster.library/MUI_SetError
  625.  
  626.    NAME
  627.      MUI_SetError -- Set an error value.
  628.  
  629.    SYNOPSIS
  630.     VOID MUI_SetError(LONG);
  631.  
  632.    FUNCTION
  633.     Setup a MUI error. MUI_Error() will return this value when
  634.     asked.
  635.  
  636.    SEE ALSO
  637.     MUI_Error()
  638.