rom/utility/namedobjectname.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: NamedObjectName()
   6     Lang: english
   7 */
   8 #include "intern.h"
   9
  10 /*****************************************************************************
  11
  12     NAME */
  13         #include <proto/utility.h>
  14
  15         AROS_LH1(STRPTR, NamedObjectName,
  16
  17 /*  SYNOPSIS */
  18         AROS_LHA(struct NamedObject *, object, A0),
  19
  20 /*  LOCATION */
  21         struct UtilityBase *, UtilityBase, 42, Utility)
  22
  23 /*  FUNCTION
  24         Return the name associated with a NamedObject.
  25
  26     INPUTS
  27         object      -   The NamedObject you want the name of.
  28
  29     RESULT
  30         The name of the object will be returned.
  31
  32     NOTES
  33
  34     EXAMPLE
  35         struct NamedObject *no;
  36         STRPTR name;
  37
  38         \* Some other code here *\
  39
  40         name = NamedObjectName( no );
  41
  42     BUGS
  43
  44     SEE ALSO
  45         utility/name.h
  46
  47     INTERNALS
  48         The name is stored in the ln_Name field of the list node.
  49
  50     HISTORY
  51         29-10-95    digulla automatically created from
  52                             utility_lib.fd and clib/utility_protos.h
  53         11-08-96    iaint   Reworked for AROS style.
  54         18-10-96    iaint   New NamedObject style.
  55
  56 *****************************************************************************/
  57 {
  58     AROS_LIBFUNC_INIT
  59
  60     /* Nice'n easy */
  61
  62     if( object )
  63         return GetIntNamedObject(object)->no_Node.ln_Name;
  64     else
  65         return NULL;
  66
  67     AROS_LIBFUNC_EXIT
  68
  69 } /* NamedObjectName */