[#absl-FlagsUsageConfig]
= xref:absl.adoc[absl]::FlagsUsageConfig
:relfileprefix: ../
:mrdocs:

This structure contains the collection of callbacks for changing the behavior of the usage reporting routines in Abseil Flags&period;

== Synopsis

Declared in `&lt;absl&sol;flags&sol;usage&lowbar;config&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct FlagsUsageConfig;
----

== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:absl/FlagsUsageConfig/contains_help_flags.adoc[`contains&lowbar;help&lowbar;flags`] 
| Returns true if flags defined in the filename should be reported with &hyphen;&hyphen;help flag&period; For example, if the file &quot;path&sol;to&sol;my&sol;code&period;cc&quot; defines the flag &quot;&hyphen;&hyphen;my&lowbar;flag&quot;, and contains&lowbar;help&lowbar;flags(&quot;path&sol;to&sol;my&sol;code&period;cc&quot;) returns true, invoking the program with &hyphen;&hyphen;help will include information about &hyphen;&hyphen;my&lowbar;flag in the program output&period;
| xref:absl/FlagsUsageConfig/contains_helppackage_flags.adoc[`contains&lowbar;helppackage&lowbar;flags`] 
| Returns true if flags defined in the filename should be reported with &hyphen;&hyphen;helppackage flag&period; For example, if the file &quot;path&sol;to&sol;my&sol;code&period;cc&quot; defines the flag &quot;&hyphen;&hyphen;my&lowbar;flag&quot;, and contains&lowbar;helppackage&lowbar;flags(&quot;path&sol;to&sol;my&sol;code&period;cc&quot;) returns true, invoking the program with &hyphen;&hyphen;helppackage will include information about &hyphen;&hyphen;my&lowbar;flag in the program output&period;
| xref:absl/FlagsUsageConfig/contains_helpshort_flags.adoc[`contains&lowbar;helpshort&lowbar;flags`] 
| Returns true if flags defined in the given source code file should be reported with &hyphen;&hyphen;helpshort flag&period; For example, if the file &quot;path&sol;to&sol;my&sol;code&period;cc&quot; defines the flag &quot;&hyphen;&hyphen;my&lowbar;flag&quot;, and contains&lowbar;helpshort&lowbar;flags(&quot;path&sol;to&sol;my&sol;code&period;cc&quot;) returns true, invoking the program with &hyphen;&hyphen;helpshort will include information about &hyphen;&hyphen;my&lowbar;flag in the program output&period;
| xref:absl/FlagsUsageConfig/normalize_filename.adoc[`normalize&lowbar;filename`] 
| Normalizes the filename specific to the build system&sol;filesystem used&period; This routine is used when we report the information about the flag definition location&period; For instance, if your build resides at some location you do not want to expose in the usage output, you can trim it to show only relevant part&period; For example&colon; normalize&lowbar;filename(&quot;&sol;my&lowbar;company&sol;some&lowbar;long&lowbar;path&sol;src&sol;project&sol;file&period;cc&quot;) might produce &quot;project&sol;file&period;cc&quot;&period;
| xref:absl/FlagsUsageConfig/version_string.adoc[`version&lowbar;string`] 
| Generates string containing program version&period; This is the string reported when user specifies &hyphen;&hyphen;version in a command line&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:absl/SetFlagsUsageConfig.adoc[`SetFlagsUsageConfig`]
| Sets the usage reporting configuration callbacks&period; If any of the callbacks are not set in usage&lowbar;config instance, then the default value of the callback is used&period;
|===


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