Difference between revisions of "Truxton file open id"

From truxwiki.com
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
uint64_t truxton_file_open_id( uint64_t truxton_handle, char const * guid_string );
 
uint64_t truxton_file_open_id( uint64_t truxton_handle, char const * guid_string );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 12: Line 12:
 
==<code>guid_string</code>==
 
==<code>guid_string</code>==
 
The string representation of the identifier of the file to get in Truxton.
 
The string representation of the identifier of the file to get in Truxton.
This corresponds to the <code>ID</code> column of the <code>File</code> table.
+
This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
 +
The [[TGUID#File_ID|file identifier]] is not random.
  
 
=Return value=
 
=Return value=
Line 18: Line 19:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
int check_it(uint64_t truxton)
+
int check_it( uint64_t truxton )
 
{
 
{
   uint64_t file = truxton_file_open_id(truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000");
+
   uint64_t file = truxton_file_open_id( truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000" );
  
   if ( file != 0 )
+
   if ( file == 0 )
 
   {
 
   {
       return(0);
+
       return( 0 );
 
   }
 
   }
  
   truxton_file_close(file);
+
   truxton_file_close( file );
   truxton_file_free(file);
+
   truxton_file_free( file );
  
   return(1)
+
   return( 1 )
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 05:42, 6 February 2026

This retrieves a file from Truxton by its GUID.

Syntax

uint64_t truxton_file_open_id( uint64_t truxton_handle, char const * guid_string );

Parameters

truxton_handle

The handle created by the truxton_create call.

guid_string

The string representation of the identifier of the file to get in Truxton. This corresponds to the [ID] column of the [File] table. The file identifier is not random.

Return value

A handle to a read-only file in Truxton.

Sample

int check_it( uint64_t truxton )
{
   uint64_t file = truxton_file_open_id( truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000" );

   if ( file == 0 )
   {
      return( 0 );
   }

   truxton_file_close( file );
   truxton_file_free( file );

   return( 1 )
}