Difference between revisions of "Truxton file get origin"

From truxwiki.com
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This retrieves the origin of the file.
 
This retrieves the origin of the file.
It corresponds to the <code>OriginID</code> column of the <code>[[File Table | File]]</code> table.
+
It corresponds to the <code>[OriginID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
uint32_t truxton_file_get_origin( uint64_t file_handle );
 
uint32_t truxton_file_get_origin( uint64_t file_handle );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 14: Line 14:
 
Where this file came from.
 
Where this file came from.
 
It will be one of the [[Origin]] values.
 
It will be one of the [[Origin]] values.
It should also be a value in the <code>ID</code> column of the <code>Origin</code> table.
+
It should also be a value in the <code>[ID]</code> column of the <code>[Origin]</code> table.
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="10">
+
<source lang="C" highlight="10">
int print_it(uint64_t truxton)
+
void print_it( uint64_t truxton )
 
{
 
{
   uint64_t file = truxton_file_open_md5(truxton, "9ec8fb6095c35eff2b236863b7caaf10");
+
   uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" );
  
 
   if ( file != 0 )
 
   if ( file != 0 )
 
   {
 
   {
       return(0);
+
       return;
 
   }
 
   }
  
Line 36: Line 36:
 
   truxton_file_free( file );
 
   truxton_file_free( file );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 04:44, 13 February 2021

This retrieves the origin of the file. It corresponds to the [OriginID] column of the [File] table.

Syntax

uint32_t truxton_file_get_origin( uint64_t file_handle );

Parameters

file_handle

The handle created by the truxton_file_open_id or truxton_file_open_md5 call.

Return value

Where this file came from. It will be one of the Origin values. It should also be a value in the [ID] column of the [Origin] table.

Sample

void print_it( uint64_t truxton )
{
   uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" );

   if ( file != 0 )
   {
      return;
   }

   uint32_t origin = truxton_file_get_origin( file );

   if ( origin == ORIGIN_GENERATED )
   {
      printf( "The file was generated by Truxton.\n" );
   }

   truxton_file_free( file );
}