Truxton C API - Revision history

Sam: /* Debugging */

2026-02-20T10:21:53Z

Debugging

Sam: /* Message Participant */

2026-02-19T10:54:37Z

Message Participant

Sam: /* Message Participant */

2026-02-19T10:48:20Z

Message Participant

Sam: /* Message Participant */

2026-02-17T11:03:09Z

Message Participant

Sam: /* Enumeration */

2026-02-13T15:19:09Z

Enumeration

Sam: /* File Record Fields */

2026-02-11T22:05:28Z

File Record Fields

Sam: /* File Type */

2026-02-08T21:15:39Z

File Type

Sam: /* Media */

2026-02-06T09:45:48Z

Media

Sam: /* Derived Objects */

2026-02-06T09:30:28Z

Derived Objects

Sam: /* Types */

2026-02-05T11:43:43Z

Types

@@ Line 979: / Line 979: @@
 ==Debugging==
 * [[truxton_dump_black_box]] - Dumps the [[Black Box|black box]] of the given process id
 * [[truxton_set_black_box_source_code_location]] - Sets a location in the [[Black Box|black box]]
 * [[truxton_set_black_box_value]] - Sets a debugging value in the [[Black Box|black box]]

@@ Line 771: / Line 771: @@
 * [[truxton_message_participant_create]] - Creates a participant in a message
 * [[truxton_message_participant_destroy]] - Frees the participant object
-* [[truxton_message_participant_get_id]] -
+* [[truxton_message_participant_get_id]] - Retrieves he globally unique identifier of the participant
-* [[truxton_message_participant_set_id]] -
+* [[truxton_message_participant_set_id]] - Sets the globally unique identifier of the participant
-* [[truxton_message_participant_get_combined_id]] -
+* [[truxton_message_participant_get_combined_id]] - Retrieves the combined id of the message address
-* [[truxton_message_participant_get_combined_guid]] -
+* [[truxton_message_participant_get_combined_guid]] - Retrieves the combined identifier as a globally unique identifier
-* [[truxton_message_participant_get_account]] -
+* [[truxton_message_participant_get_account]] - Retrieves the account portion of the message address
-* [[truxton_message_participant_set_account]] -
+* [[truxton_message_participant_set_account]] - Sets the account portion of the message address
-* [[truxton_message_participant_get_file_id]] -
+* [[truxton_message_participant_get_file_id]] - Retrieves the globally unique identifier of the file containing this participant
-* [[truxton_message_participant_set_file_id]] -
+* [[truxton_message_participant_set_file_id]] - Sets the globally unique identifier of the file containing this participant
-* [[truxton_message_participant_get_media_id]] -
+* [[truxton_message_participant_get_media_id]] - Retrieves the globally unique identifier of the media containing this participant
-* [[truxton_message_participant_set_media_id]] -
+* [[truxton_message_participant_set_media_id]] - Sets the globally unique identifier of the media containing this participant
-* [[truxton_message_participant_get_message_address_id]] -
+* [[truxton_message_participant_get_message_address_id]] - Retrieved the globally unique identifier of the message address
-* [[truxton_message_participant_set_message_address_id]] -
+* [[truxton_message_participant_set_message_address_id]] - Sets the globally unique identifier of the message address
-* [[truxton_message_participant_get_message_id]] -
+* [[truxton_message_participant_get_message_id]] - Retrieves the globally unique identifier for the participant
-* [[truxton_message_participant_set_message_id]] -
+* [[truxton_message_participant_set_message_id]] - Sets the globally unique identifier for the participant
-* [[truxton_message_participant_get_server]] -
+* [[truxton_message_participant_get_server]] - Retrieves the server portion of the participant address
-* [[truxton_message_participant_set_server]] -
+* [[truxton_message_participant_set_server]] - Sets the server portion of the participant address
-* [[truxton_message_participant_get_name]] -
+* [[truxton_message_participant_get_name]] - Retrieves the name portion of the participant address
-* [[truxton_message_participant_set_name]] -
+* [[truxton_message_participant_set_name]] - Sets the name portion of the participant address
 * [[truxton_message_participant_get_type]] - Gets the [[Message Participants|role]] this participant took in the message
 * [[truxton_message_participant_set_type]] - Sets the [[Message Participants|role]] this participant took in the message

@@ Line 789: / Line 789: @@
 * [[truxton_message_participant_get_name]] -
 * [[truxton_message_participant_set_name]] -
-* [[truxton_message_participant_get_type]] -
+* [[truxton_message_participant_get_type]] - Gets the [[Message Participants|role]] this participant took in the message
 * [[truxton_message_participant_set_type]] - Sets the [[Message Participants|role]] this participant took in the message

@@ Line 769: / Line 769: @@
 It is used internally during the enumeration of the participants of a communication.
-* [[truxton_message_participant_create]] -
+* [[truxton_message_participant_create]] - Creates a participant in a message
-* [[truxton_message_participant_destroy]] -
+* [[truxton_message_participant_destroy]] - Frees the participant object
 * [[truxton_message_participant_get_id]] -
 * [[truxton_message_participant_set_id]] -
@@ Line 790: / Line 790: @@
 * [[truxton_message_participant_set_name]] -
 * [[truxton_message_participant_get_type]] -
-* [[truxton_message_participant_set_type]] -
+* [[truxton_message_participant_set_type]] - Sets the [[Message Participants|role]] this participant took in the message
 ==Options==

@@ Line 270: / Line 270: @@
 * [[truxton_enumeration_get_current_investigation]] - Retrieves the parent investigation of the current enumerated item
 * [[truxton_enumeration_get_current_media]] - Retrieves the parent media of the current enumerated item
 * [[truxton_enumeration_get_next]] - Retrieves the next item in the enumeration
 * [[truxton_enumeration_get_scope]] - Retrieves the scope of the enumeration
 * [[truxton_enumeration_get_scope_id]] - Retrieves the specific item being enumerated
 * [[truxton_enumeration_get_target]] - Retrieves what is being enumerated
 * [[truxton_enumeration_set_scope]] - Sets the scope of the enumeration
 * [[truxton_enumeration_set_scope_id]] - Sets the specific identifier of the scope

@@ Line 480: / Line 480: @@
 * [[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
 ===Derived Objects===

@@ Line 508: / Line 508: @@
 ==File Type==
 * [[truxton_file_type_create]] - Creates a file type object.
 * [[truxton_file_type_destroy]] - Frees any resources allocated for this file type object.
 * [[truxton_file_type_get_id]] - Retrieves the identifier you assigned to this file type.

@@ Line 652: / Line 652: @@
 These are the API's that allow you to add to the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table in the database.
 * [[truxton_media_create]] - Creates a new media object
 * [[truxton_media_open_id]] - Opens an existing media in the database given the media's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID].
 * [[truxton_media_destroy]] - Frees any resources allocated to this object

@@ Line 494: / Line 494: @@
 * [[truxton_file_open_id]] - Retrieves a particular file specified by the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID].
 * [[truxton_file_open_md5]] - Retrieves the first file in Truxton whose contents have the given [https://en.wikipedia.org/wiki/MD5 MD5] hash.
 * [[truxton_file_tag]] - Creates a tag and puts it on this file. This data will be saved to the <code>[Tagged]</code> table.

@@ Line 882: / Line 882: @@
 Here's how to get a list of them.
 * [[truxton_get_data_type_names]] - Retrieves mappings from the <code>[DataType]</code> table
 * [[truxton_get_depot_status_names]] - Retrieves mappings from the <code>[DepotStatus]</code> table