[#BloombergLP-balcl-CommandLineOptionsHandle]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balcl.adoc[balcl]::CommandLineOptionsHandle
:relfileprefix: ../../
:mrdocs:

This class provides access to the parsed options (if any) of its creating `CommandLine` object.

== Synopsis

Declared in `<balcl_commandline.h>`

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

== Description

The behavior is undefined if any of the methods of this class (accessors all) are invoked after a subsequent invocation of the `parse` method of the creating object or after the destruction of the creating object.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balcl/CommandLineOptionsHandle/index.adoc[`index`] 
| Return the position of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/name.adoc[`name`] 
| Return the name of the option at the specified `index`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/numOptions.adoc[`numOptions`] 
| Return the number of parsed options.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/the-02.adoc[`the`] 
| `the` overloads
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theBool.adoc[`theBool`] 
| Return the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theChar.adoc[`theChar`] 
| Return the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theCharArray.adoc[`theCharArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDate.adoc[`theDate`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDateArray.adoc[`theDateArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDatetime.adoc[`theDatetime`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDatetimeArray.adoc[`theDatetimeArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDouble.adoc[`theDouble`] 
| Return the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theDoubleArray.adoc[`theDoubleArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theInt.adoc[`theInt`] 
| Return the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theInt64.adoc[`theInt64`] 
| Return the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theInt64Array.adoc[`theInt64Array`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theIntArray.adoc[`theIntArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theString.adoc[`theString`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theStringArray.adoc[`theStringArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theTime.adoc[`theTime`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/theTimeArray.adoc[`theTimeArray`] 
| Return a `const` reference to the value of the option having the specified `name`.
| xref:BloombergLP/balcl/CommandLineOptionsHandle/type-0e.adoc[`type`] 
| `type` overloads
| xref:BloombergLP/balcl/CommandLineOptionsHandle/value-0f.adoc[`value`] 
| `value` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balcl/operator_not_eq-008.adoc[BloombergLP::balcl::operator!=]`
| Return `true` if the specified `lhs` and `rhs` do not have the same value, and `false` otherwise.
| `xref:BloombergLP/balcl/operator_eq-0e.adoc[BloombergLP::balcl::operator==]`
| Return `true` if the specified `lhs` and `rhs` have the same value, and `false` otherwise.
| `xref:BloombergLP/balcl/CommandLine.adoc[BloombergLP::balcl::CommandLine]`
| This value‐semantic `class` parses, validates, and provides access to command‐line arguments.
|===


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