[#BloombergLP-bdlar-EnumRef]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlar.adoc[bdlar]::EnumRef
:relfileprefix: ../../
:mrdocs:

Type‐erased non‐const reference to an object in the `bdlat` enumeration type category.

== Synopsis

Declared in `<bdlar_enumref.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class EnumRef;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/EnumRef/2constructor-02.adoc[`EnumRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlar/EnumRef/fromInt.adoc[`fromInt`] 
| Assign the enumerator value matching the specified `number`. Return 0 on success, and a non‐zero value with no effect on the object if `number` does not match any enumerator.
| xref:BloombergLP/bdlar/EnumRef/fromString.adoc[`fromString`] 
| Assign the enumerator value matching the specified `string` of the specified `stringLength`. Return 0 on success, and a non‐zero value with no effect on the object if `string` and `stringLength` do not match any enumerator.
| xref:BloombergLP/bdlar/EnumRef/hasFallback.adoc[`hasFallback`] 
| Return `true` if the specified enumerator held by this object supports a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/EnumRef/isFallback.adoc[`isFallback`] 
| Return `true` if the specified enumerator held by this object is equal to a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/EnumRef/makeFallback.adoc[`makeFallback`] 
| Assign the fallback enumerator value. Return 0 on success, and a non‐zero value with no effect on the object if it does not have a fallback enumerator.
| xref:BloombergLP/bdlar/EnumRef/objectAddress.adoc[`objectAddress`] 
| Return a pointer to the wrapped object.
| xref:BloombergLP/bdlar/EnumRef/reset.adoc[`reset`] 
| Reset the referred object to the default value.
| xref:BloombergLP/bdlar/EnumRef/toInt.adoc[`toInt`] 
| Load into the specified `result` the integer representation of the enumerator value held by this object.
| xref:BloombergLP/bdlar/EnumRef/toString.adoc[`toString`] 
| Load into the specified `result` the string representation of the enumerator value held by this object.
| xref:BloombergLP/bdlar/EnumRef/vtable.adoc[`vtable`] 
| Return a pointer to the vtable.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/bdlat_enumFromInt.adoc[`bdlat_enumFromInt`]
| Assign the enumerator value matching the specified `number` to the specified `result`. Return 0 on success, and a non‐zero value with no effect on the object if `number` does not match any enumerator.
| xref:BloombergLP/bdlar/bdlat_enumFromString.adoc[`bdlat_enumFromString`]
| Assign the enumerator value matching the specified `string` of the specified `stringLength` to the specified `result`. Return 0 on success, and a non‐zero value with no effect on the object if `string` and `stringLength` do not match any enumerator.
| xref:BloombergLP/bdlar/bdlat_enumHasFallback-00.adoc[`bdlat_enumHasFallback`]
| Return `true` if the specified `value` supports a fallback enumerator, and `false` otherwise.
| xref:BloombergLP/bdlar/bdlat_enumIsFallback-01.adoc[`bdlat_enumIsFallback`]
| Return `true` if the specified `value` is a fallback enumerator.
| xref:BloombergLP/bdlar/bdlat_enumMakeFallback.adoc[`bdlat_enumMakeFallback`]
| Assign the fallback enumerator value to the specified `result`. Return 0 on success, and a non‐zero value with no effect on the object if it does not have a fallback enumerator.
| xref:BloombergLP/bdlar/bdlat_valueTypeReset-0d0.adoc[`bdlat_valueTypeReset`]
| Reset the specified `ref` to the default value.
|===


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