[#BloombergLP-bdlc-HashTable-insert-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlc.adoc[bdlc]::xref:BloombergLP/bdlc/HashTable.adoc[HashTable]::insert
:relfileprefix: ../../../
:mrdocs:

Insert an element with the specified `key` into this object.

== Synopsis

Declared in `<bdlc_hashtable.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
insert(
    xref:BloombergLP/bdlc/HashTable/Handle.adoc[Handle]* handle,
    KEY const& key);
----

== Description

Insert an element with the specified `key` into this object; load a handle to the new element into the specified `handle`. Return true if successful, and false otherwise. The behavior is undefined unless `key` does not evaluate to a "null" or "removed" bucket, as defined by the parameterized `TRAITS` (see the component‐level documentation for more details). Note that this method will fail to compile unless the `VALUE` parameter is `bslmf::Nil`.

== Return Value

`true` if the element was inserted, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *handle*
| handle loaded with the inserted element on success
| *key*
| key of the element to insert
|===


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