Difference between revisions of "File Export Criteria"
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 |- |...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| 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" | ||
| Line 12: | Line 13: | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE</code> | ||
| style="text-align:center;" | 1 | | style="text-align:center;" | 1 | ||
| − | | The size of the file to export. This corresponds to the <code>[OSLength]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | The size of the file to export. This corresponds to the <code><nowiki>[</nowiki>[[File Table#OSLength|OSLength]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MINIMUM</code> | ||
| style="text-align:center;" | 2 | | style="text-align:center;" | 2 | ||
| − | | Sets the minimum length of the file to export. This corresponds to the <code>[OSLength]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the minimum length of the file to export. This corresponds to the <code><nowiki>[</nowiki>[[File Table#OSLength|OSLength]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_SIZE_MAXIMUM</code> | ||
| style="text-align:center;" | 3 | | style="text-align:center;" | 3 | ||
| − | | Sets the maximum length of the file to export. This corresponds to the <code>[OSLength]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the maximum length of the file to export. This corresponds to the <code><nowiki>[</nowiki>[[File Table#OSLength|OSLength]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| − | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH</code> | + | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_HASH</code>File_Table#HashID |
| style="text-align:center;" | 4 | | style="text-align:center;" | 4 | ||
| − | | Sets the desired hash of the file to export. This corresponds to the <code>[HashID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the desired hash of the file to export. This corresponds to the <code><nowiki>[</nowiki>[[File Table#HashID|HashID]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_NAME</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_NAME</code> | ||
| Line 40: | Line 41: | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_TYPE</code> | ||
| style="text-align:center;" | 8 | | style="text-align:center;" | 8 | ||
| − | | The [[File Types Supported| | + | | The [[File Types Supported|type]] of the desired file. This corresponds to the <code><nowiki>[</nowiki>[[File Table#FileTypeID|FileTypeID]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_PARENT_ID</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_PARENT_ID</code> | ||
| style="text-align:center;" | 9 | | style="text-align:center;" | 9 | ||
| − | | Sets the identifier of the parent of the desired file. This corresponds to the <code>[ParentFileID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the identifier of the parent of the desired file. This corresponds to the <code><nowiki>[</nowiki>[[File Table#ParentFileID|ParentFileID]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_ID</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_ID</code> | ||
| style="text-align:center;" | 10 | | style="text-align:center;" | 10 | ||
| − | | Sets the identifier of the desired file. This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the identifier of the desired file. This corresponds to the <code><nowiki>[</nowiki>[[File Table#ID|ID]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_MEDIA</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_MEDIA</code> | ||
| style="text-align:center;" | 11 | | style="text-align:center;" | 11 | ||
| − | | Sets the identifier of the media of the desired file. This corresponds to the <code>[MediaID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. | + | | Sets the identifier of the media of the desired file. This corresponds to the <code><nowiki>[</nowiki>[[File Table#MediaID|MediaID]]<nowiki>]</nowiki></code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
|- | |- | ||
| <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT</code> | | <code>TRUXTON_EXPORT_FILE_QUERY_FIELD_LIMIT</code> | ||
Latest revision as of 16:00, 5 May 2025
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_HASHFile_Table#HashID
|
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 type 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. |
