Difference between revisions of "Truxton delete media"

From truxwiki.com
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
=Syntax=
 
=Syntax=
 
<source lang="C">
 
<source lang="C">
uint32_t truxton_delete_media( uint64_t trutxon_handle, char const * media_id );
+
uint32_t truxton_delete_media( uint64_t truxton_handle, char const * media_id );
 
</source>
 
</source>
  
Line 15: Line 15:
  
 
=Return value=
 
=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 Media|message]] could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.
  
 
=Sample=
 
=Sample=

Latest revision as of 08:30, 26 July 2022

This deletes a piece of media from Truxton.

Syntax

uint32_t truxton_delete_media( uint64_t truxton_handle, char const * media_id );

Parameters

truxton_handle

The handle created by the truxton_create call.

media_id

The identifier of the media to delete. This should be a value from the [ID] column of the [Media] table.

Return value

Zero if the message could not be sent to the maintenance queue, non-zero if the message was successfully sent.

Sample

void delete_training_media( uint64_t truxton )
{
   truxton_delete_media( truxton, "1997aa6c-bda8-d9ec-341b-0d8cb64104bf" );
}