Difference between revisions of "Truxton file get number of children"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This is the number files records that have this file as their parent. It corresponds to the <code>NumberOfChildren</code> column of the <code>File</code> table. =Syntax= <syn...")
 
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This is the number files records that have this file as their parent.
 
This is the number files records that have this file as their parent.
It corresponds to the <code>NumberOfChildren</code> column of the <code>File</code> table.
+
It corresponds to the <code>[NumberOfChildren]</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_number_of_children( uint64_t file_handle )
+
uint32_t truxton_file_get_number_of_children( uint64_t file_handle );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
 
==<code>file_handle</code>==
 
==<code>file_handle</code>==
 
+
The handle created by the [[truxton_file_open_id]] or [[truxton_file_open_md5]] call.
The handle created by the [[truxton_file_open_id]] of [[truxton_file_open_md5]] call.
 
  
 
=Return value=
 
=Return value=
Line 16: Line 15:
  
 
=Sample=
 
=Sample=
 
+
<source lang="C" highlight="10">
<syntaxhighlight lang="C" highlight="10">
+
void print_id( uint64_t truxton )
int 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 )
 
   {
 
   {
       return(0);
+
       return;
 
   }
 
   }
  
 
   uint32_t count = truxton_file_get_number_of_children( file );
 
   uint32_t count = truxton_file_get_number_of_children( file );
 +
  truxton_file_free( file );
  
   printf( "There are $" PRIu32 " children of this file.\n", count );
+
   printf( "There are %" PRIu32 " children of this file.\n", count );
 
}
 
}
</syntaxhighlight>
+
</source>
 +
 
 +
The <code>PRIu32</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 32-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 04:44, 13 February 2021

This is the number files records that have this file as their parent. It corresponds to the [NumberOfChildren] column of the [File] table.

Syntax

uint32_t truxton_file_get_number_of_children( uint64_t file_handle );

Parameters

file_handle

The handle created by the truxton_file_open_id or truxton_file_open_md5 call.

Return value

The number of file records that have this file as their parent.

Sample

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

   if ( file != 0 )
   {
      return;
   }

   uint32_t count = truxton_file_get_number_of_children( file );
   truxton_file_free( file );

   printf( "There are %" PRIu32 " children of this file.\n", count );
}

The PRIu32 in the sample code above is a standard way of formatting a 32-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.