Truxton communication tag
Jump to navigation
Jump to search
This will tag the communication.
You can only tag a communication file after truxton_communication_save() has been called.
This will cause a record to be created in the [Tagged] table.
Contents
Syntax
int truxton_communication_tag( uint64_t communication_handle, char const * tag_name, char const * why, uint64_t origin );
Parameters
communication_handle
The handle created by the truxton_communication_create call.
tag_name
The small bit of text that will serve as the tag.
This will show up in the user interface.
This parameter must match one of the values in the [Name] column of the [Tag] table.
You can create tags using the truxton_create_tag API.
why
The reason why this item was tagged.
origin
What produced this tag. If an algorithm produced this tag, it should be set to 1. If you are calling this method because a human told you to, the value should be 2.
Return value
A non-zero value on success, zero on failure.
Sample
void add_hypersonic_tag( uint64_t communication_handle )
{
if ( truxton_communication_tag( communication_handle, "HAWC", "Analyst found a reference to HAWC", 2 ) == 0 )
{
printf( "Failed to tag communication\n" );
}
}