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

Managed handle to a key/data pair in a `SkipList`.

== Synopsis

Declared in `<bdlcc_skiplist.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class KEY,
    class DATA>
class SkipListPairHandle;
----

== Description

Objects of this class refer to an association (pair) in a `SkipList`. A `bdlcc::SkipListPairHandle` is implicitly convertible to a `const Pair*` and thus may be used anywhere in the `SkipList` API that a `const Pair*` is expected.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/SkipListPairHandle/2constructor-06.adoc[`SkipListPairHandle`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlcc/SkipListPairHandle/2destructor.adoc[`~SkipListPairHandle`] [.small]#[destructor]#
| Destroy this `SkipListPairHandle`. If this `SkipListPairHandle` refers to a pair in the list, release the reference.
| xref:BloombergLP/bdlcc/SkipListPairHandle/operator_assign.adoc[`operator=`] 
| Make this handle refer to the same pair as `rhs`.
| xref:BloombergLP/bdlcc/SkipListPairHandle/data-00.adoc[`data`] 
| `data` overloads
| xref:BloombergLP/bdlcc/SkipListPairHandle/isValid.adoc[`isValid`] 
| Return `true` if this PairHandle currently refers to a pair, and `false` otherwise.
| xref:BloombergLP/bdlcc/SkipListPairHandle/key-05.adoc[`key`] 
| `key` overloads
| xref:BloombergLP/bdlcc/SkipListPairHandle/release.adoc[`release`] 
| Release the reference (if any) managed by this `SkipListPairHandle`.
| xref:BloombergLP/bdlcc/SkipListPairHandle/releaseReferenceRaw.adoc[`releaseReferenceRaw`] 
| Release this handle and return the raw list and pair pointers.
| xref:BloombergLP/bdlcc/SkipListPairHandle/2conversion.adoc[`operator bdlcc::SkipListPair<KEY, DATA> const*`] 
| Return the address of the pair referred to by this `SkipListPairHandle`, or 0 if this handle does not manage a reference.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlcc/SkipList-0a.adoc[BloombergLP::bdlcc::SkipList]`
| Thread‐safe ordered associative skip list of key/data pairs.
|===


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