Difference between revisions of "File Export Criteria"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "These defined constants represent the criteria you can set for exporting files from Truxton. {| class="wikitable" ! Name ! Value ! Meaning |- |...")
 
Line 1: Line 1:
 
These defined constants represent the criteria you can set for [[Truxton_C_API#File_Export|exporting]] files from Truxton.
 
These defined constants represent the criteria you can set for [[Truxton_C_API#File_Export|exporting]] files from Truxton.
 +
These are the values used in the <code>field</code> parameter of the <code>[[truxton_file_export_add_criteria]]()</code> API.
  
 
{| class="wikitable"
 
{| class="wikitable"

Revision as of 05:24, 2 December 2020

These defined constants represent the criteria you can set for exporting files from Truxton. These are the values used in the field parameter of the truxton_file_export_add_criteria() API.

Name Value Meaning
TRUXTON_EXPORT_FILE_QUERY_FIELD_UNKNOWN 0 We don't know what the criteria is.
TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE 1 The size of the file to export. This corresponds to the [OSLength] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM 2 Sets the minimum length of the file to export. This corresponds to the [OSLength] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM 3 Sets the maximum length of the file to export. This corresponds to the [OSLength] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH 4 Sets the desired hash of the file to export. This corresponds to the [HashID] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_NAME 5 Not supported at this time.
TRUXTON_EXPORT_FILE_QUERY_FIELD_NAME_LIKE 6 Not supported at this time.
TRUXTON_EXPORT_FILE_QUERY_FIELD_NAME_ID 7 Not supported at this time.
TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE 8 The File Types Supportedtype of the desired file. This corresponds to the [FileTypeID] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_PARENT_ID 9 Sets the identifier of the parent of the desired file. This corresponds to the [ParentFileID] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_ID 10 Sets the identifier of the desired file. This corresponds to the [ID] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_MEDIA 11 Sets the identifier of the media of the desired file. This corresponds to the [MediaID] column of the [File] table.
TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT 12 Sets the maximum number of files to export.