rom/utility/releasenamedobject.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: ReleaseNamedObject()
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include "intern.h"
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14         #include <proto/utility.h>
  15
  16         AROS_LH1(void, ReleaseNamedObject,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(struct NamedObject *, object, A0),
  20
  21 /*  LOCATION */
  22         struct UtilityBase *, UtilityBase, 43, Utility)
  23
  24 /*  FUNCTION
  25         Releases a NamedObject that you previously obtained by calling
  26         FindNamedObject.
  27
  28     INPUTS
  29         object      -   The NamedObject to release.
  30
  31     RESULT
  32         The NamedObject will be released from your possession, and if it
  33         is ready to be deallocated, then the NamedObject will be freed.
  34
  35     NOTES
  36         WARNING: You really should actually have found the NamedObject
  37             first (that is with FindNamedObject()) before calling this
  38             function. Failure to take heed of this will cause memory
  39             use problems.
  40
  41     EXAMPLE
  42         struct NamedObject *nObj, *myNameSpace;
  43
  44         if( nObj = FindNamedObject( myNameSpace, "Some Name", NULL ) )
  45         {
  46             \*
  47                 Here you do whatever you want. However The NamedObject
  48                 structure should generally be treated READ-ONLY
  49             *\
  50
  51             ReleaseNamedObject( nObj );
  52         }
  53
  54     BUGS
  55
  56     SEE ALSO
  57         utility/name.h, FindNamedObject()
  58
  59     INTERNALS
  60
  61     HISTORY
  62         29-10-95    digulla automatically created from
  63                             utility_lib.fd and clib/utility_protos.h
  64         11-08-96    iaint   Adapted for AROS 1.5+.
  65         18-10-96    iaint   Changed for different format NamedObjects.
  66
  67 *****************************************************************************/
  68 {
  69     AROS_LIBFUNC_INIT
  70
  71     struct IntNamedObject *no;
  72
  73     if( object )
  74     {
  75         Forbid();
  76         no = GetIntNamedObject( object );
  77
  78         /* if(no more users) */
  79         if( --no->no_UseCount == 0 )
  80         {
  81             if( no->no_FreeMessage )    RemNamedObject( object, NULL );
  82         }
  83         Permit();
  84     }
  85
  86     AROS_LIBFUNC_EXIT
  87
  88 } /* ReleaseNamedObject */