Truxton event get description

This retrieves the description of the event. This corresponds to the [Description] column of the [Event] table.

Syntax

void truxton_event_get_description( uint64_t event_handle, char * destination_string, size_t max_size );

Parameters

event_handle

The handle to an event created by the truxton_event_create call.

destination_string

The string to be written to.

max_size

The maximum number of characters that can be written to destination_string.

Sample

void dump_event(uint64_t event_handle)
{
   char temp_string[ 256 ];

   truxton_event_get_file_id( event_handle, temp_string, sizeof(temp_string) );
   printf( "File ID is %s\n", temp_string);

   truxton_event_get_media_id( event_handle, temp_string, sizeof(temp_string) );
   printf( "Media ID is %s\n", temp_string);

   truxton_event_get_id( event_handle, temp_string, sizeof(temp_string) );
   printf( "Event ID is %s\n", temp_string);

   truxton_event_get_title( event_handle, temp_string, sizeof(temp_string) );
   printf( "Title is %s\n", temp_string);

   truxton_event_get_description( event_handle, temp_string, sizeof(temp_string) );
   printf( "Description is %s\n", temp_string);

   uint64_t value = truxton_event_get_type( event_handle );
   printf( "Type is %" PRIu64 "\n", value );

   value = truxton_event_get_start( event_handle );
   printf( "Start is %" PRIu64 "\n", value );

   value = truxton_event_get_end( event_handle );
   printf( "End is %" PRIu64 "\n", value );
}