rom/boopsi/getattr.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Get an Attribute from a BOOPSI Class.
   6     Lang: english
   7 */
   8 #include <proto/alib.h>
   9 #include "intern.h"
  10 #include <clib/intuition_protos.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <intuition/classusr.h>
  16 #include <proto/boopsi.h>
  17
  18         AROS_LH3(ULONG, GetAttr,
  19
  20 /*  SYNOPSIS */
  21         AROS_LHA(ULONG   , attrID, D0),
  22         AROS_LHA(Object *, object, A0),
  23         AROS_LHA(IPTR *  , storagePtr, A1),
  24
  25 /*  LOCATION */
  26         struct Library *, BOOPSIBase, 9, BOOPSI)
  27
  28 /*  FUNCTION
  29         Asks the specified object for the value of an attribute. This is not
  30         possible for all attributes of an object. Read the documentation for
  31         the class to find out which can be read and which can't.
  32
  33     INPUTS
  34         attrID - ID of the attribute you want
  35         object - Ask the attribute from this object
  36         storagePtr - This is a pointer to memory which is large enough
  37                 to hold a copy of the attribute. Most classes will simply
  38                 put a copy of the value stored in the object here but this
  39                 behaviour is class specific. Therefore read the instructions
  40                 in the class description carefully.
  41
  42     RESULT
  43         Mostly TRUE if the method is supported for the specified attribute
  44         and FALSE if it isn't or the attribute can't be read at this time.
  45         See the classes documentation for details.
  46
  47     NOTES
  48         This function sends OM_GET to the object.
  49
  50     EXAMPLE
  51
  52     BUGS
  53
  54     SEE ALSO
  55         NewObjectA(), DisposeObject(), SetAttrsA(), MakeClass(),
  56         "Basic Object-Oriented Programming System for Intuition" and
  57         "boopsi Class Reference" Dokument.
  58
  59
  60     INTERNALS
  61
  62     HISTORY
  63         29-10-95    digulla automatically created from
  64                             intuition_lib.fd and clib/intuition_protos.h
  65
  66 *****************************************************************************/
  67 {
  68     AROS_LIBFUNC_INIT
  69     struct opGet get;
  70
  71     get.MethodID    = OM_GET;
  72     get.opg_AttrID  = attrID;
  73     get.opg_Storage = storagePtr;
  74
  75     return (DoMethodA (object, (Msg)&get));
  76     AROS_LIBFUNC_EXIT
  77 } /* GetAttr */