Truxton option get boolean - Revision history

Sam at 18:07, 9 February 2021

2021-02-09T18:07:25Z

Sam at 15:04, 18 January 2021

2021-01-18T15:04:17Z

Sam: /* Return value */

2020-07-27T09:09:38Z

Return value

Sam at 08:57, 27 July 2020

2020-07-27T08:57:00Z

Sam: /* Sample */

2020-07-27T08:44:55Z

Sample

Sam: Created page with "This destroys an options object. =Syntax= int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name ); =P..."

2020-07-27T08:44:39Z

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..."

New page

This destroys an options object.

=Syntax=
<syntaxhighlight lang="C">
int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name );
</syntaxhighlight>

=Parameters=
==<code>options_handle</code>==
The handle to the options object created by calling the <code>[[truxton_options_create]]</code> function.

==<code>name</code>==
The name of the option to read.

=Return value=
Zero if the boolean value is false, one if the boolean value is true.

=Sample=
<syntaxhighlight lang="C" line highlight="5">
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);
}
</syntaxhighlight>

@@ Line 19: / Line 19: @@
 =Sample=
 <source lang="C" highlight="5">
-void process_free(void)
+void process_free( void )
+{
     uint64_t options = truxton_options_create();
-    if ( truxton_options_get_boolean("pfree") == 1 )
+    if ( truxton_options_get_boolean( "pfree" ) == 1 )
+    {
        printf( "Yes, we will process free space\n" );
@@ Line 32: / Line 32: @@
+    }
-    truxton_options_destroy(options);
+    truxton_options_destroy( options );
+}
 </source>

← Older revision		Revision as of 08:57, 27 July 2020
Line 1:		Line 1:
−	~~This destroys an options object~~.	+	Reads a boolean setting.

	=Syntax=		=Syntax=

@@ Line 2: / Line 2: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 int64_t truxton_options_get_boolean( uint64_t options_handle, char const * name );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 18: / Line 18: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="5">
+<source lang="C" highlight="5">
 void process_free(void)
+{
@@ Line 34: / Line 34: @@
     truxton_options_destroy(options);
+}
-</syntaxhighlight>
+</source>

@@ Line 15: / Line 15: @@
 =Return value=
 Zero if the boolean value is false, one if the boolean value is true.
 =Sample=