Truxton option get string - Revision history

Sam at 18:09, 9 February 2021

2021-02-09T18:09:10Z

Sam at 16:06, 18 January 2021

2021-01-18T16:06:59Z

Sam: Created page with "This destroys an options object. =Syntax= void truxton_options_get_string( uint64_t options_handle, char const * name, char * destination_string, s..."

2020-07-27T09:07:09Z

Created page with "This destroys an options object. =Syntax= <syntaxhighlight lang="C"> void truxton_options_get_string( uint64_t options_handle, char const * name, char * destination_string, s..."

New page

This destroys an options object.

=Syntax=
<syntaxhighlight lang="C">
void truxton_options_get_string( uint64_t options_handle, char const * name, char * destination_string, size_t max_size );
</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.

==<code>destination_string</code>==
The string to be written to.

==<code>max_size</code>==
The maximum number of characters that can be written to <code>destination_string</code>

=Return value=
The value of the setting if specified.
If the option name is not found, an empty string is returned.

=Sample=
<syntaxhighlight lang="C" highlight="7">
void print_starting_MFT(void)
{
char folder_name[ MAX_PATH ];

uint64_t options = truxton_options_create();

truxton_options_get_string( options, "tempdir", folder_name, sizeof( folder_name ) );

printf( "Temporary files will be written to %s\n", folder_name );

truxton_options_destroy(options);
}
</syntaxhighlight>

@@ Line 25: / Line 25: @@
 =Sample=
 <source lang="C" highlight="7">
-void print_starting_MFT(void)
+void print_starting_MFT( void )
+{
     char folder_name[ MAX_PATH ];
@@ Line 35: / Line 35: @@
     printf( "Temporary files will be written to %s\n", folder_name );
-    truxton_options_destroy(options);
+    truxton_options_destroy( options );
+}
 </source>

@@ Line 1: / Line 1: @@
-This destroys an options object.
+Reads a string setting.
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 void truxton_options_get_string( uint64_t options_handle, char const * name, char * destination_string, size_t max_size );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 24: / Line 24: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="7">
+<source lang="C" highlight="7">
 void print_starting_MFT(void)
+{
@@ Line 37: / Line 37: @@
     truxton_options_destroy(options);
+}
-</syntaxhighlight>
+</source>