[#llvm-opt-arg_iterator]
= xref:llvm.adoc[llvm]::xref:llvm/opt.adoc[opt]::arg_iterator
:relfileprefix: ../../
:mrdocs:

arg_iterator ‐ Iterates through arguments stored inside an ArgList.

== Synopsis

Declared in `<llvm/Option/ArgList.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename BaseIter,
    unsigned int NumOptSpecifiers = 0>
class arg_iterator;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:llvm/opt/arg_iterator/difference_type.adoc[`difference_type`] 
| Type used to represent distances between iterators.
| xref:llvm/opt/arg_iterator/iterator_category.adoc[`iterator_category`] 
| Iterator category tag for this forward iterator.
| xref:llvm/opt/arg_iterator/pointer.adoc[`pointer`] 
| Type of pointers obtained from this iterator.
| xref:llvm/opt/arg_iterator/reference.adoc[`reference`] 
| Type of references obtained by dereferencing this iterator.
| xref:llvm/opt/arg_iterator/value_type.adoc[`value_type`] 
| Type of values obtained by dereferencing this iterator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/opt/arg_iterator/2constructor.adoc[`arg_iterator`]         [.small]#[constructor]#
| Construct an argument iterator over []`Current,` `End).`
| xref:llvm/opt/arg_iterator/operator_star.adoc[`operator*`] 
| Return a reference to the current argument.
| xref:llvm/opt/arg_iterator/operator_inc-00.adoc[`operator++`] 
| Increment operators
| xref:llvm/opt/arg_iterator/operator_ptr.adoc[`operator‐>`] 
| Return a pointer to the current argument.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/opt/operator_not_eq.adoc[llvm::opt::operator!=]`
| Return true if `LHS` and `RHS` refer to different positions.
| `xref:llvm/opt/operator_eq.adoc[llvm::opt::operator==]`
| Return true if `LHS` and `RHS` refer to the same position.
|===


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