Difference between revisions of "Truxton option get boolean"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This destroys an options object. =Syntax= <syntaxhighlight lang="C"> int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name ); </syntaxhighlight> =P...")
 
Line 17: Line 17:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" line highlight="5">
+
<syntaxhighlight lang="C" highlight="5">
 
void process_free(void)
 
void process_free(void)
 
{
 
{

Revision as of 04:44, 27 July 2020

This destroys an options object.

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.

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);
}