Difference between revisions of "Truxton child file end write"

From truxwiki.com
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
void truxton_child_file_end_write( uint64_t child_handle );
 
void truxton_child_file_end_write( uint64_t child_handle );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
 
==<code>child_handle</code>==
 
==<code>child_handle</code>==
 
 
The handle created by the [[truxton_child_file_create]] call.
 
The handle created by the [[truxton_child_file_create]] call.
  
 
=Remarks=
 
=Remarks=
 
 
If the [[truxton_child_file_set_modified | modified]] time was not set on the file prior to writing, the modified timestamp will be set to when the current time.
 
If the [[truxton_child_file_set_modified | modified]] time was not set on the file prior to writing, the modified timestamp will be set to when the current time.
 
If the [[truxton_child_file_set_size | file size]] was not set on the file prior to writing, it will be set to the total number of byte written to the file.
 
If the [[truxton_child_file_set_size | file size]] was not set on the file prior to writing, it will be set to the total number of byte written to the file.
  
 
=Sample=
 
=Sample=
 
+
<source lang="C" highlight="28">
<syntaxhighlight lang="C" highlight="35">
+
void add_text( uint64_t truxton, uint64_t parent_file )
void add_text(uint64_t truxton, uint64_t parent_file)
 
 
{
 
{
   truxton_start_adding_files(truxton);
+
   truxton_start_adding_files( truxton );
  
   uint64_t child = truxton_child_file_create(truxton);
+
   uint64_t child = truxton_child_file_create( truxton );
  
 
   char id[40];
 
   char id[40];
  
   truxton_file_get_id(parent_file, id, sizeof(id));
+
   truxton_file_get_id( parent_file, id, sizeof(id) );
   truxton_child_file_set_parent_id(child, id);
+
   truxton_child_file_set_parent_id( child, id );
   truxton_child_file_set_type(child, Type_ASCII_Text);
+
   truxton_child_file_set_type( child, Type_ASCII_Text );
   truxton_child_file_set_name(child, "Hi.txt");
+
   truxton_child_file_set_name( child, "Hi.txt" );
 
 
  FILETIME now;
 
 
 
  GetSystemTimeAsFileTime(&now);
 
 
 
  ULARGE_INTEGER ticks;
 
  
   ticks.LowPart = now.dwLowDateTime;
+
   uint64_t now = truxton_time_now();
  ticks.HighPart = now.dwHighDateTime;
 
  
   truxton_child_file_set_created(child, ticks.QuadPart);
+
   truxton_child_file_set_created( child, now );
   truxton_child_file_set_accessed(child, ticks.QuadPart);
+
   truxton_child_file_set_accessed( child, now );
   truxton_child_file_set_modified(child, ticks.QuadPart);
+
   truxton_child_file_set_modified( child, now );
  
   truxton_child_file_set_origin(child, ORIGIN_GENERATED);
+
   truxton_child_file_set_origin( child, ORIGIN_GENERATED );
  
   truxton_child_file_begin_write(child);
+
   truxton_child_file_begin_write( child );
  
 
   char * message = "Hello World\n";
 
   char * message = "Hello World\n";
  
   truxton_child_file_write( child, message, strlen(message));
+
   truxton_child_file_write( child, message, strlen(message) );
  
 
   truxton_child_file_end_write( child );
 
   truxton_child_file_end_write( child );
  
   if ( truxton_child_file_save(child) == 0 )
+
   if ( truxton_child_file_save( child ) == 0 )
 
   {
 
   {
 
       printf( "Failed to add child to Truxton\n" );
 
       printf( "Failed to add child to Truxton\n" );
 
   }
 
   }
  
   truxton_child_file_destroy(child);
+
   truxton_child_file_destroy( child );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 02:59, 14 April 2024

This API tells Truxton that you are finished writing contents.

Syntax

void truxton_child_file_end_write( uint64_t child_handle );

Parameters

child_handle

The handle created by the truxton_child_file_create call.

Remarks

If the modified time was not set on the file prior to writing, the modified timestamp will be set to when the current time. If the file size was not set on the file prior to writing, it will be set to the total number of byte written to the file.

Sample

void add_text( uint64_t truxton, uint64_t parent_file )
{
   truxton_start_adding_files( truxton );

   uint64_t child = truxton_child_file_create( truxton );

   char id[40];

   truxton_file_get_id( parent_file, id, sizeof(id) );
   truxton_child_file_set_parent_id( child, id );
   truxton_child_file_set_type( child, Type_ASCII_Text );
   truxton_child_file_set_name( child, "Hi.txt" );

   uint64_t now = truxton_time_now();

   truxton_child_file_set_created( child, now );
   truxton_child_file_set_accessed( child, now );
   truxton_child_file_set_modified( child, now );

   truxton_child_file_set_origin( child, ORIGIN_GENERATED );

   truxton_child_file_begin_write( child );

   char * message = "Hello World\n";

   truxton_child_file_write( child, message, strlen(message) );

   truxton_child_file_end_write( child );

   if ( truxton_child_file_save( child ) == 0 )
   {
      printf( "Failed to add child to Truxton\n" );
   }

   truxton_child_file_destroy( child );
}