Difference between revisions of "Truxton file get is eliminated"

From truxwiki.com
Jump to navigation Jump to search
Line 14: Line 14:
 
=Return value=
 
=Return value=
 
The non-zero when this file's contents were eliminated for some reason and not written to a depot.
 
The non-zero when this file's contents were eliminated for some reason and not written to a depot.
 +
Zero when the file's contents were not eliminated.
  
 
=Sample=
 
=Sample=

Revision as of 18:35, 11 December 2020

This returns non-zero if the file's contents exist contiguously within the contents of another file. It corresponds to the [ContentStatusID] column of the [File] table.

Syntax

int truxton_file_get_is_eliminated( uint64_t file_handle );

Parameters

file_handle

The handle created by the truxton_file_open_id or truxton_file_open_md5 call. It should contain a value that matches the [ID] of the [Contentstatus] table or a defined constant.

Return value

The non-zero when this file's contents were eliminated for some reason and not written to a depot. Zero when the file's contents were not eliminated.

Sample

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

   if ( file != 0 )
   {
      return;
   }

   if ( truxton_file_get_is_eliminated( file ) == 0 )
   {
      printf( "The contents were not eliminated.\n" );
   }
   else
   {
      printf( "The contents were eliminated.\n" );
   }

   truxton_file_free( file );
}