Contents

removeObject

Remove an object by key from the dictionary.

Declaration

void removeObject(const OSObject *aKey);
virtual void removeObject(const OSString *aKey);

Parameters

  • aKey:

    An object pointer used to lookup the object. The key should be uniqued within the dictionary. Usually an OSString is passed as the key.

Return Value

true on success, which retains the object, or false on failure which does not retain the object.

Discussion

An object in the dictionary with the given key object is removed and released.

See Also

Accessing Keys and Values