Difference between revisions of "Truxton message get file 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 file this message is about. This corresponds to the <code>ID</code> column of the...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this message is about.
 
This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this message is about.
This corresponds to the <code>ID</code> column of the <code>[[File Table | File]]</code> table.
+
This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_message_get_file_id( uint64_t message_handle, char * destination_string, size_t max_size );
 
void truxton_message_get_file_id( uint64_t message_handle, char * destination_string, size_t max_size );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 18: Line 18:
  
 
=Sample=
 
=Sample=
 
+
<source lang="C" highlight="5">
<syntaxhighlight lang="C" highlight="12">
+
void print_id( uint64_t message_handle )
int print_id(uint64_t message_handle)
 
 
{
 
{
 
   char guid_string[ 40 ];
 
   char guid_string[ 40 ];
  
   truxton_message_get_file_id( message_handle, guid_string, sizeof(guid_string));
+
   truxton_message_get_file_id( message_handle, guid_string, sizeof(guid_string) );
  
   printf( "File ID is %s\n", guid_string);
+
   printf( "File ID is %s\n", guid_string );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 12:30, 9 February 2021

This retrieves the GUID of the file this message is about. This corresponds to the [ID] column of the [File] table.

Syntax

void truxton_message_get_file_id( uint64_t message_handle, char * destination_string, size_t max_size );

Parameters

message_handle

The handle to a message created by the truxton_message_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 print_id( uint64_t message_handle )
{
   char guid_string[ 40 ];

   truxton_message_get_file_id( message_handle, guid_string, sizeof(guid_string) );

   printf( "File ID is %s\n", guid_string );
}