Difference between revisions of "Truxton file get is eliminated"
Jump to navigation
Jump to search
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This returns non-zero if the file's contents exist contiguously within the contents of another file. | This returns non-zero if the file's contents exist contiguously within the contents of another file. | ||
| − | It corresponds to the <code>ContentStatusID</code> column of the <code>[[File Table | File]]</code> table. | + | It corresponds to the <code>[ContentStatusID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table. |
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
| − | int truxton_file_get_is_eliminated( uint64_t file_handle ) | + | int truxton_file_get_is_eliminated( uint64_t file_handle ); |
| − | </ | + | </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]] or [[truxton_file_open_md5]] call. | ||
| + | It should contain a value that matches the <code>[ID]</code> of the <code>[Contentstatus]</code> table or a [[Content Status|defined constant]]. | ||
=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= | ||
| − | < | + | <source lang="C" highlight="10"> |
| − | + | 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 ) | ||
{ | { | ||
| − | return | + | return; |
} | } | ||
| Line 34: | Line 35: | ||
printf( "The contents were eliminated.\n" ); | printf( "The contents were eliminated.\n" ); | ||
} | } | ||
| + | |||
| + | truxton_file_free( file ); | ||
} | } | ||
| − | </ | + | </source> |
Latest revision as of 04:41, 13 February 2021
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 );
}
