Difference between revisions of "Truxton file export execute"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This API uses the criteria and options to export files from Truxton. =Syntax= <source lang="C"> uint64_t truxton_file_export_execute(uint64_t export_handle); </source> =Para...")
 
Line 8: Line 8:
 
=Parameters=
 
=Parameters=
 
==<code>export_handle</code>==
 
==<code>export_handle</code>==
The export instance.
+
The handle to an export instance created by the <code>[[truxton_file_export_create]]()</code> call.
This handle comes from calling <code>[[truxton_file_export_create]]()</code>.
 
  
 
=Sample=
 
=Sample=

Revision as of 05:07, 2 December 2020

This API uses the criteria and options to export files from Truxton.

Syntax

uint64_t truxton_file_export_execute(uint64_t export_handle);

Parameters

export_handle

The handle to an export instance created by the truxton_file_export_create() call.

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