Truxton file export set option - Revision history

Sam: /* Sample */

2024-02-03T14:57:52Z

Sample

Sam: /* Sample */

2024-02-03T14:48:09Z

Sample

Sam: /* TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT */

2021-03-29T18:22:08Z

TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT

Sam: /* Sample */

2021-03-29T18:20:56Z

Sample

Sam: /* Options */

2021-03-29T18:17:36Z

Options

Sam: /* TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT */

2021-03-29T18:16:22Z

TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT

Sam: /* TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT */

2021-03-29T18:15:38Z

TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT

Sam at 11:27, 10 February 2021

2021-02-10T11:27:52Z

Sam: /* TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT */

2020-12-03T15:30:02Z

TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT

Sam: Created page with "This gives you the ability to specify the output format to export from Truxton. =Syntax= void truxton_file_export_set_option(uint64_t export_handle, uint64_..."

2020-12-02T09:28:54Z

Created page with "This gives you the ability to specify the output format to export from Truxton. =Syntax= <source lang="C"> void truxton_file_export_set_option(uint64_t export_handle, uint64_..."

New page

This gives you the ability to specify the output format to export from Truxton.

=Syntax=
<source lang="C">
void truxton_file_export_set_option(uint64_t export_handle, uint64_t option, char const * value);
</source>

=Parameters=
==<code>export_handle</code>==
The handle to an export instance created by the <code>[[truxton_file_export_create]]()</code> call.

==<code>option</code>==
Which [[File Export Options|option]] to set.

==<code>value</code>==
The string representation of the option.

=Options=
The following are the possible options to set.

==<code>TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT</code>==
The format of the names of files to export.

==<code>TRUXTON_EXPORT_FILE_OPTION_FOLDER</code>==
The folder where exported files should be written.

==<code>TRUXTON_EXPORT_FILE_OPTION_TAR</code>==
The name of the tar file to write to.
This is an optional parameter.
If you don't set this, files will be written to the destination folder.

=Sample=
<source lang="C" highlight="38,41,44">
#include "TruxtonCAPI.h"
#pragma comment(lib, "TruxtonCAPI.lib")

#include "filetypes.h"
#include <stdlib.h>
#pragma hdrstop

int main()
{
char temporary_string[256];

truxton_start();

uint64_t truxton = truxton_create();

uint64_t export_handle = truxton_file_export_create(truxton);

// We want a variety of file types
sprintf_s(temporary_string, sizeof(temporary_string), "%d, %d, %d", Type_JPEGWithExif, Type_JPEG, Type_GIF);
truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE, temp_string);

// We only want files where the MD5 hash starts with "e4"
truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH, "e4");

// We want a file that is at least 4MB long
truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM, "4194304");

// We want a file that is no larger than 5MB
truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM, "5242880");

// Limit the output to a single file
truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT, "1");

truxton_file_export_where_clause(export_handle, temporary_string, sizeof(temporary_string));
printf( "Will use the following WHERE clause to select files: %s\n", temporary_string);

// Rename the file being exported to include the hash before the original name
truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT, "{hash}_{name}");

// The files should be output to a particular folder
truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_FOLDER, "C:\\temp");

// We want them output to a TAR file in that particular folder
truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_TAR, "JPGWithExif.tar");

// Go find the files and output them to C:\temp\JPGWithExif.tar
truxton_file_export_execute(export_handle);

// Clean up
truxton_file_export_destroy(export_handle);
truxton_destroy(truxton);
truxton_stop();
}
</source>

@@ Line 60: / Line 60: @@
 #pragma hdrstop
-int main( void )
+void main( void )
+{
      char temporary_string[256];

@@ Line 38: / Line 38: @@
 |}
-'''NOTE''' If <code>{ext}</code> is used and the file type has no extension, the integer value of the file type will be used instead.
+'''NOTE''' If <code>{ext}</code> is used and the file type has no extension registered in the <code>[FileType]</code> table, the integer value of the file type will be used instead.
 ==<code>TRUXTON_EXPORT_FILE_OPTION_FOLDER</code>==

@@ Line 37: / Line 37: @@
 | The original name of the file.
 |}
 ==<code>TRUXTON_EXPORT_FILE_OPTION_FOLDER</code>==

@@ Line 27: / Line 27: @@
 ! Field
 ! Meaning
 |-
 | <code>{hash}</code>

@@ Line 52: / Line 52: @@
 =Sample=
-<source lang="C" highlight="38,41,44">
+<source lang="C" highlight="38,41,44,47">
 #include "TruxtonCAPI.h"
 #pragma comment(lib, "TruxtonCAPI.lib")
@@ Line 97: / Line 97: @@
      // We want them output to a TAR file in that particular folder
      truxton_file_export_set_option( export_handle, TRUXTON_EXPORT_FILE_OPTION_TAR, "JPGWithExif.tar" );
      // Go find the files and output them to C:\temp\JPGWithExif.tar

@@ Line 47: / Line 47: @@
 This is an optional parameter.
 If you don't set this, files will be written to the destination folder.
 =Sample=

@@ Line 3: / Line 3: @@
 =Syntax=
 <source lang="C">
-void truxton_file_export_set_option(uint64_t export_handle, uint64_t option, char const * value);
+void truxton_file_export_set_option( uint64_t export_handle, uint64_t option, char const * value );
 </source>
@@ Line 60: / Line 60: @@
      uint64_t truxton = truxton_create();
-     uint64_t export_handle = truxton_file_export_create(truxton);
+     uint64_t export_handle = truxton_file_export_create( truxton );
      // We want a variety of file types
-     sprintf_s(temporary_string, sizeof(temporary_string), "%d, %d, %d", Type_JPEGWithExif, Type_JPEG, Type_GIF);
+     sprintf_s( temporary_string, sizeof(temporary_string), "%d, %d, %d", Type_JPEGWithExif, Type_JPEG, Type_GIF );
-     truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE, temp_string);
+     truxton_file_export_add_criteria( export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE, temp_string );
      // We only want files where the MD5 hash starts with "e4"
-     truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH, "e4");
+     truxton_file_export_add_criteria( export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH, "e4" );
      // We want a file that is at least 4MB long
-     truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM, "4194304");
+     truxton_file_export_add_criteria( export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM, "4194304" );
      // We want a file that is no larger than 5MB
-     truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM, "5242880");
+     truxton_file_export_add_criteria( export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM, "5242880" );
      // Limit the output to a single file
-     truxton_file_export_add_criteria(export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT, "1");
+     truxton_file_export_add_criteria( export_handle, TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT, "1" );
-     truxton_file_export_where_clause(export_handle, temporary_string, sizeof(temporary_string));
+     truxton_file_export_where_clause( export_handle, temporary_string, sizeof(temporary_string) );
-     printf( "Will use the following WHERE clause to select files: %s\n", temporary_string);
+     printf( "Will use the following WHERE clause to select files: %s\n", temporary_string );
      // Rename the file being exported to include the hash before the original name
-     truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT, "{hash}_{name}");
+     truxton_file_export_set_option( export_handle, TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT, "{hash}_{name}" );
      // The files should be output to a particular folder
-     truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_FOLDER, "C:\\temp");
+     truxton_file_export_set_option( export_handle, TRUXTON_EXPORT_FILE_OPTION_FOLDER, "C:\\temp" );
      // We want them output to a TAR file in that particular folder
-     truxton_file_export_set_option(export_handle, TRUXTON_EXPORT_FILE_OPTION_TAR, "JPGWithExif.tar");
+     truxton_file_export_set_option( export_handle, TRUXTON_EXPORT_FILE_OPTION_TAR, "JPGWithExif.tar" );
      // Go find the files and output them to C:\temp\JPGWithExif.tar
-     truxton_file_export_execute(export_handle);
+     truxton_file_export_execute( export_handle );
      // Clean up
-     truxton_file_export_destroy(export_handle);
+     truxton_file_export_destroy( export_handle );
-     truxton_destroy(truxton);
+     truxton_destroy( truxton );
      truxton_stop();
+}
 </source>

@@ Line 21: / Line 21: @@
 ==<code>TRUXTON_EXPORT_FILE_OPTION_NAME_FORMAT</code>==
 The format of the names of files to export.
 ==<code>TRUXTON_EXPORT_FILE_OPTION_FOLDER</code>==