Difference between revisions of "Truxton options destroy"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This destroys an options object. =Syntax= <syntaxhighlight lang="C"> void truxton_options_destroy( uint64_t options_handle ); </syntaxhighlight> =Parameters= ==<code>options...")
 
Line 7: Line 7:
  
 
=Parameters=
 
=Parameters=
==<code>options_handle </code>==
+
==<code>options_handle</code>==
 
The handle to the options object created by calling the <code>[[truxton_options_create]]</code> function.
 
The handle to the options object created by calling the <code>[[truxton_options_create]]</code> function.
  

Revision as of 04:41, 27 July 2020

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