Difference between revisions of "Truxton event get id"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the event. This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</no...")
 
 
Line 20: Line 20:
 
=Sample=
 
=Sample=
 
<source lang="C" highlight="11">
 
<source lang="C" highlight="11">
void dump_event(uint64_t event_handle)
+
void dump_event( uint64_t event_handle )
 
{
 
{
 
   char guid_string[ 40 ];
 
   char guid_string[ 40 ];
Line 37: Line 37:
 
}
 
}
 
</source>
 
</source>
 +
 +
The <code>PRIu64</code> in the sample code above is a standard way of [https://en.wikipedia.org/wiki/C_data_types#Printf_and_scanf_format_specifiers formatting] a 64-bit unsigned integer in C.
 +
Over the years, different compilers on different operating systems used different format specifiers for things, these <code>PRI</code> macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.

Latest revision as of 07:35, 6 February 2021

This retrieves the GUID of the event. This corresponds to the [ID] column of the [Event] table. If you created this event, the identifier only becomes available after you have called truxton_event_save.

Syntax

void truxton_event_get_id( 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 guid_string[ 40 ];

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

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

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

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

The PRIu64 in the sample code above is a standard way of formatting a 64-bit unsigned integer in C. Over the years, different compilers on different operating systems used different format specifiers for things, these PRI macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.