Sam: Created page with "Determines if a value exists in the options. =Syntax= int64_t truxton_options_exists( uint64_t options_handle, char const * name ); =Parameters=..."

2021-03-05T14:44:20Z

Created page with "Determines if a value exists in the options. =Syntax= <source lang="C"> int64_t truxton_options_exists( uint64_t options_handle, char const * name ); </source> =Parameters=..."

New page

Determines if a value exists in the options.

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

=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 test for.

=Return value=
Zero if the value is no where to be found in the options.
One is returned if the named option was found.

=Remarks=
It is not possible for <code>[[truxton_option_get_boolean|truxton_options_get_boolean]]()</code> to tell you if a false value was specified by the user or the default value of false was used.
This method will tell you if the named setting exists anywhere in Truxton.

=Sample=
<source lang="C" highlight="5">
void process_free( void )
{
uint64_t options = truxton_options_create();

if ( truxton_options_exists( "pfree" ) == 1 )
{
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" );
}
}
else
{
printf( "The user did not specify the pfree option, we will assume they do not want to process free space.\n" );
}

truxton_options_destroy( options );
}
</source>

Truxton options exists - Revision history

Sam: Created page with "Determines if a value exists in the options. =Syntax= int64_t truxton_options_exists( uint64_t options_handle, char const * name ); =Parameters=..."