Difference between revisions of "Truxton options destroy"

From truxwiki.com
Jump to navigation Jump to search
Line 2: Line 2:
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_options_destroy( uint64_t options_handle );
 
void truxton_options_destroy( uint64_t options_handle );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 14: Line 14:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="14">
+
<source lang="C" highlight="14">
 
void process_free(void)
 
void process_free(void)
 
{
 
{
Line 30: Line 30:
 
   truxton_options_destroy(options);
 
   truxton_options_destroy(options);
 
}
 
}
</syntaxhighlight>
+
</source>

Revision as of 12:07, 18 January 2021

This destroys an options object.

Syntax

void truxton_options_destroy( uint64_t options_handle );

Parameters

options_handle

The handle to the options object created by calling the truxton_options_create function.

Return value

A handle to an options object.

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