Sam: /* Return value */

2022-07-26T12:33:17Z

Return value

Sam: Created page with "This will go through depot storage and remove any depots that have be marked ToBeDeleted. When consolidation happens, it will copy the contents..."

2021-05-20T21:04:12Z

Created page with "This will go through depot storage and remove any depots that have be marked ToBeDeleted. When consolidation happens, it will copy the contents..."

New page

This will go through depot storage and remove any depots that have be marked ToBeDeleted.
When [[truxton_consolidate_depots|consolidation]] happens, it will copy the contents of a smaller depot to a larger one.
When all of the files in the small depot have been merged into the larger depot, the record in the <code>[Depot]</code> table will be deleted and the depot file itself will be renamed with an extension of <code>.ToBeDeleted</code>

=Syntax=
<source lang="C">
uint32_t truxton_delete_depots( uint64_t truxton_handle );
</source>

=Parameters=
==<code>truxton_handle</code>==
The handle created by the [[truxton_create]] call.

=Return value=
Zero if the message could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.

=Sample=
<source lang="C" highlight="3">
void cleanup_the_depot_folder( uint64_t truxton )
{
if ( truxton_delete_depots( truxton ) != 0 )
{
printf( "Message sent to delete unused depots\n" );
}
}
</source>

@@ Line 13: / Line 13: @@
 =Return value=
-Zero if the message could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.
+Zero if the [[Message Bus Messages#Delete Depots|message]] could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.
 =Sample=

Truxton delete depots - Revision history

Sam: /* Return value */

Sam: Created page with "This will go through depot storage and remove any depots that have be marked ToBeDeleted. When consolidation happens, it will copy the contents..."