Difference between revisions of "Truxton file export create"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This is the first step in exporting files from Truxton. A file export object holds the criteria and options for exporting files. =Syntax= <source lang="C"> uint64_t truxton_f...")
 
Line 6: Line 6:
 
uint64_t truxton_file_export_create(uint64_t truxton_handle);
 
uint64_t truxton_file_export_create(uint64_t truxton_handle);
 
</source>
 
</source>
 +
 +
=Parameters=
 +
==<code>truxton_handle</code>==
 +
The Truxton instance this exporter will be working with.
 +
This handle comes from calling <code>[[truxton_create]]()</code>.
  
 
=Sample=
 
=Sample=

Revision as of 04:46, 2 December 2020

This is the first step in exporting files from Truxton. A file export object holds the criteria and options for exporting files.

Syntax

uint64_t truxton_file_export_create(uint64_t truxton_handle);

Parameters

truxton_handle

The Truxton instance this exporter will be working with. This handle comes from calling truxton_create().

Sample

#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");

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