Difference between revisions of "Truxton C API"

From truxwiki.com
Jump to navigation Jump to search
Line 117: Line 117:
  
 
==File Record Fields==
 
==File Record Fields==
−
* [[truxton_file_get_id]] - Reads the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]
 
−
* [[truxton_file_get_media_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file's media
 
−
* [[truxton_file_get_parent_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file's parent
 
−
* [[truxton_file_get_number_of_children]] - Returns the number of files that have this one as their parent
 
−
* [[truxton_file_get_is_resident]] - Tells you if the file's contents exist contiguously within its parent
 
−
* [[truxton_file_get_created]] - Reads the file's creation timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
 
 
* [[truxton_file_get_accessed]] - Reads the file's last access timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
 
* [[truxton_file_get_accessed]] - Reads the file's last access timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
−
* [[truxton_file_get_modified]] - Reads the file's last write timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
 
−
* [[truxton_file_get_name]] - Reads the name of the file
 
 
* [[truxton_file_get_attributes]] - Reads the attributes of the file
 
* [[truxton_file_get_attributes]] - Reads the attributes of the file
−
* [[truxton_file_get_size]] - Reads the size of the file as recorded in the directory entry for the file
 
−
* [[truxton_file_get_origin]] - Reads the [[Origin | origin]] of the file's contents
 
 
* [[truxton_file_get_content_status]] - Reads the [[Content Status | status]] of the file's contents
 
* [[truxton_file_get_content_status]] - Reads the [[Content Status | status]] of the file's contents
−
* [[truxton_file_get_type]] - Reads the [[File Types Supported | type]] of the file
+
* [[truxton_file_get_created]] - Reads the file's creation timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
−
* [[truxton_file_get_hash]] - Reads the [https://en.wikipedia.org/wiki/MD5 MD5] of the file's contents
 
−
* [[truxton_file_get_entropy]] - Reads the [https://en.wikipedia.org/wiki/Entropy_(information_theory) entropy] of the file's contents
 
−
* [[truxton_file_get_disk_offset]] - Reads physical offset of the first byte of the file's contents
 
−
* [[truxton_file_get_is_eliminated]] - Tells you of the file's contents were discarded
 
 
* [[truxton_file_get_depot_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the [[Depot | depot]] holding the file's contents
 
* [[truxton_file_get_depot_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the [[Depot | depot]] holding the file's contents
 
* [[truxton_file_get_depot_length]] - Reads the number of bytes in the [[Depot | depot]] taken by this file's contents
 
* [[truxton_file_get_depot_length]] - Reads the number of bytes in the [[Depot | depot]] taken by this file's contents
 
* [[truxton_file_get_depot_name]] - Reads the file name of the [[Depot | depot]] holding this file's contents
 
* [[truxton_file_get_depot_name]] - Reads the file name of the [[Depot | depot]] holding this file's contents
 
* [[truxton_file_get_depot_offset]] - The offset from the beginning of the [[Depot | depot]] where this file's contents begin
 
* [[truxton_file_get_depot_offset]] - The offset from the beginning of the [[Depot | depot]] where this file's contents begin
 +
* [[truxton_file_get_disk_offset]] - Reads physical offset of the first byte of the file's contents
 +
* [[truxton_file_get_entropy]] - Reads the [https://en.wikipedia.org/wiki/Entropy_(information_theory) entropy] of the file's contents
 +
* [[truxton_file_get_hash]] - Reads the [https://en.wikipedia.org/wiki/MD5 MD5] of the file's contents
 +
* [[truxton_file_get_id]] - Reads the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]
 +
* [[truxton_file_get_is_eliminated]] - Tells you of the file's contents were discarded
 +
* [[truxton_file_get_is_resident]] - Tells you if the file's contents exist contiguously within its parent
 +
* [[truxton_file_get_media_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file's media
 +
* [[truxton_file_get_modified]] - Reads the file's last write timestamp in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks
 +
* [[truxton_file_get_number_of_children]] - Returns the number of files that have this one as their parent
 +
* [[truxton_file_get_name]] - Reads the name of the file
 +
* [[truxton_file_get_number_of_children]] - Returns the number of files that have this one as their parent
 +
* [[truxton_file_get_origin]] - Reads the [[Origin | origin]] of the file's contents
 +
* [[truxton_file_get_parent_id]] - Reads the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file's parent
 +
* [[truxton_file_get_size]] - Reads the size of the file as recorded in the directory entry for the file
 +
* [[truxton_file_get_signature]] - Gets the first four bytes of the contents as an integer
 +
* [[truxton_file_get_type]] - Reads the [[File Types Supported | type]] of the file
 
* [[truxton_file_get_details]] - Retrieves JSON with details of the file's contents
 
* [[truxton_file_get_details]] - Retrieves JSON with details of the file's contents
 
* [[truxton_file_get_truxton]] - Retrieves the Truxton connection used to get this file
 
* [[truxton_file_get_truxton]] - Retrieves the Truxton connection used to get this file

Revision as of 07:33, 21 June 2020

Truxton functionality is exposed to the C programming world as a DLL named TruxtonCAPI.dll in the C:\Program Files\Truxton\SDK folder. This DLL can be called from any programming language that has the ability to make operating system calls.

Philosophy

The API is considered to be "flat" in that only sixty-four bit integers and ASCII character strings are used in the interface. This was chosen to make it easy for other languages to interface to. The coding convention is all lower case names with underscores separating words. Truxton is a member of the east const posse.

API Groups

The API is broken down into the different areas of Truxton.

Initialization

Functions

ETL Functions

Child Files

A child file is one that you have created and need to save in Truxton.

Creating things related to this file:

File IO

File Record Fields

Create Objects from File

The following APIs are used to create objects with a file as their parent.

Debugging

Media

Message

File Export

Artifacts

Event

EXIF (Camera Information)

File Type

Geographic Location

Relation

Website Visit

USB Device

Retrieved from "https://truxwiki.com/index.php?title=Truxton_C_API&oldid=1826"