[#BloombergLP-bdlcc-ObjectCatalog-remove]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::xref:BloombergLP/bdlcc/ObjectCatalog.adoc[ObjectCatalog]::remove
:relfileprefix: ../../../
:mrdocs:

Remove the object with the specified `handle` from this catalog.

== Synopsis

Declared in `<bdlcc_objectcatalog.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
remove(
    int handle,
    TYPE* valueBuffer = 0);
----

== Description

Optionally load into the optionally specified `valueBuffer` the value of the object having the specified `handle` and remove it from this catalog. Return zero on success, and a non‐zero value if the `handle` is not contained in this catalog. Note that `valueBuffer` is assigned into, and thus must point to a valid `TYPE` instance.

== Return Value

0 on success, and a non‐zero value if not found

== Parameters

[cols="1,4"]
|===
| Name| Description
| *handle*
| handle of the object to remove
| *valueBuffer*
| optional buffer that receives the removed value
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#