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

This class provides a type‐erased, read‐only reference to an array value that dispatches operations through a vtable.

== Synopsis

Declared in `<bdlar_arrayref.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/ArrayConstRef/2constructor-0c.adoc[`ArrayConstRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlar/ArrayConstRef/accessElement.adoc[`accessElement`] 
| Invoke the specified `accessor` on the array element at the specified `index`. The supplied `accessor` must be a callable type that can be called as if it had the following signature: ` int accessor(const ELEMENT& ref); ` Return the value from the invocation of `accessor`. The behavior is undefined unless `0 <= index < size()`.
| xref:BloombergLP/bdlar/ArrayConstRef/elementCategory.adoc[`elementCategory`] 
| Return the element type category of the wrapped array.
| xref:BloombergLP/bdlar/ArrayConstRef/objectAddress.adoc[`objectAddress`] 
| Return a pointer to the wrapped array.
| xref:BloombergLP/bdlar/ArrayConstRef/size.adoc[`size`] 
| Return the number of elements in the wrapped array.
| xref:BloombergLP/bdlar/ArrayConstRef/vtable.adoc[`vtable`] 
| Return a pointer to the vtable.
| xref:BloombergLP/bdlar/ArrayConstRef/xsdName.adoc[`xsdName`] 
| Return the `bdlat_TypeName::xsdName` value for the underlying object.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlar/bdlat_TypeName_xsdName-0a.adoc[`bdlat_TypeName_xsdName`]
| Return the XSD name for the specified `ref` using the specified `format`.
| xref:BloombergLP/bdlar/bdlat_arrayAccessElement-01.adoc[`bdlat_arrayAccessElement`]
| Invoke the specified `accessor` on the array element at the specified `index` of the specified `array`. Return the value from the invocation of `accessor`.
| xref:BloombergLP/bdlar/bdlat_arraySize-00.adoc[`bdlat_arraySize`]
| Return the number of elements in the specified `array`.
|===


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