Difference between revisions of "Truxton option get boolean"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name ); | int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name ); | ||
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 18: | Line 18: | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="5"> |
void process_free(void) | void process_free(void) | ||
{ | { | ||
| Line 34: | Line 34: | ||
truxton_options_destroy(options); | truxton_options_destroy(options); | ||
} | } | ||
| − | </ | + | </source> |
Revision as of 11:04, 18 January 2021
Reads a boolean setting.
Syntax
int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name );
Parameters
options_handle
The handle to the options object created by calling the truxton_options_create function.
name
The name of the option to read.
Return value
Zero if the boolean value is false, one if the boolean value is true. If the named option is not found, false is returned.
Sample
void process_free(void)
{
uint64_t options = truxton_options_create();
if ( truxton_options_get_boolean("pfree") == 1 )
{
printf( "Yes, we will process free space\n" );
}
else
{
printf( "No, we will not process free space\n" );
}
truxton_options_destroy(options);
}
