Truxton location tag

This will tag the location. It will cause a record to be created in the [Tagged] table.

Syntax

int truxton_location_tag( uint64_t location_handle, char const * tag_name, char const * why, uint64_t origin );

Parameters

location_handle

This handle comes from calling truxton_location_create() or truxton_child_file_create_location()

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 tag_murder( uint64_t location_handle, uint64_t time_of_death_low, uint64_t time_of_death_high )
{
   uint64_t ticks = truxton_location_get_when( location_handle );

   if ( ticks >= time_of_death_low && ticks <= time_of_death_high )
   {
      truxton_location_tag( location_handle, "Time of Death", "Location was visited during time of death window", TAG_ORIGIN_AUTOMATIC );
   }
}