Truxton C API

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

• truxton_start - Initializes Truxton
• truxton_stop - Uninitializes Truxton

ETL Functions

• truxton_create - Creates a Truxton object
• truxton_destroy - Frees a Truxton object
• truxton_get_device_id - Retrieves the Device identifier
• truxton_get_etl_id - Retrieves the identifier for this ETL process
• truxton_get_machine_id - Retrieves the machine identifier
• truxton_get_version - Retrieves the version of Truxton
• truxton_start_adding_files - Prepares Truxton to add files to the database

Child Files

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

• truxton_child_file_create - Create a file object to save to Truxton
• truxton_child_file_destroy - Destroys a file object
• truxton_child_file_clear - Returns a file object to an initial state of all zeroes
• truxton_child_file_get_id - Retrieves the unique id of a file
• truxton_child_file_set_id - Sets the unique id of a file
• truxton_child_file_get_parent_id -
• truxton_child_file_set_parent_id -
• truxton_child_file_get_media_id -
• truxton_child_file_set_media_id -
• truxton_child_file_set_name -
• truxton_child_file_get_path -
• truxton_child_file_set_path -
• truxton_child_file_get_hash -
• truxton_child_file_get_number_of_children -
• truxton_child_file_set_number_of_children -
• truxton_child_file_get_created -
• truxton_child_file_set_created -
• truxton_child_file_get_accessed -
• truxton_child_file_set_accessed -
• truxton_child_file_get_modified -
• truxton_child_file_set_modified -
• truxton_child_file_get_size -
• truxton_child_file_set_size -
• truxton_child_file_get_origin -
• truxton_child_file_set_origin -
• truxton_child_file_get_content_status -
• truxton_child_file_set_content_status -
• truxton_child_file_get_truxton -
• truxton_child_file_begin_write -
• truxton_child_file_end_write -
• truxton_child_file_write -
• truxton_child_file_save -
• truxton_child_file_set_type -
• truxton_child_file_get_type -
• truxton_child_file_set_attributes -
• truxton_child_file_get_attributes -
• truxton_child_file_set_disk_offset -
• truxton_child_file_get_disk_offset -
• truxton_child_file_get_entropy -