Difference between revisions of "Truxton file get depot name"

From truxwiki.com
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
This retrieves the name of depot file where the contents are stored.
+
This retrieves the name of [[Depot|depot file]] where the contents are stored.
It corresponds to the <code>Filename</code> column of the <code>Depot</code> table.
+
It corresponds to the <code>[Filename]</code> column of the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_file_get_depot_name( uint64_t file_handle, char * destination_string, size_t max_size );
 
void truxton_file_get_depot_name( uint64_t file_handle, char * destination_string, size_t max_size );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 18: Line 18:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="12">
+
<source lang="C" highlight="12">
void print_id(uint64_t truxton)
+
void print_id( 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 )
Line 30: Line 30:
 
   char name_string[ MAX_PATH ];
 
   char name_string[ MAX_PATH ];
  
   truxton_file_get_depot_name(file, name_string, sizeof(name_string));
+
   truxton_file_get_depot_name( file, name_string, sizeof(name_string) );
  
   printf( "Depot is %s\n", name_string);
+
   printf( "Depot is %s\n", name_string );
  
   truxton_file_free(file);
+
   truxton_file_free( file );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 08:25, 28 January 2024

This retrieves the name of depot file where the contents are stored. It corresponds to the [Filename] column of the [Depot] table.

Syntax

void truxton_file_get_depot_name( uint64_t file_handle, char * destination_string, size_t max_size );

Parameters

file_handle

The handle created by the truxton_file_open_id or truxton_file_open_md5 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 truxton )
{
   uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" );

   if ( file != 0 )
   {
      return;
   }

   char name_string[ MAX_PATH ];

   truxton_file_get_depot_name( file, name_string, sizeof(name_string) );

   printf( "Depot is %s\n", name_string );

   truxton_file_free( file );
}