.. highlightlang:: us

.. _obj_remove:

obj_remove
==========

.. index:: obj_remove

.. us.tag  obj_remove NOTREADYENGLISH New410 obj

:ref:`obj_remove` removes a key-value pair from an object.

.. function::  bool = obj_remove(obj, key)

.. us.return

**Return Value**

*bool* is TRUE (1) if the key-value pair has been removed or FALSE (0) if an error
occurred.

.. us.params

**Parameters**

.. uparam:: obj

   *obj* is the object created with :ref:`obj_create`.

.. uparam:: key

   *key* is an integer number or a string.

.. us.example

**Example**

::

   obj = obj_create()
   obj.obj = obj_create()
   obj.obj.test = "Hello"
   obj[12] = 13
   obj.a = 111
   obj.remove(12)
   obj.remove("a")
   obj.remove("obj");
   print obj.count

.. seealso::
   :ref:`overview-uniscript-objects`,
   :ref:`obj_has_key`

:sub:`id-458810`