Difference between revisions of "Truxton delete media"
Jump to navigation
Jump to search
(Created page with "This deletes a piece of media from Truxton. =Syntax= <source lang="C"> void truxton_delete_media( uint64_t trutxon_handle, char const * media_id ); </source> =Parameters= ==...") |
|||
| 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 ); | |
</source> | </source> | ||
| Line 13: | Line 13: | ||
The identifier of the media to delete. | The identifier of the media to delete. | ||
This should be a value from the <code>[ID]</code> column of the <code>[Media]</code> table. | This should be a value from the <code>[ID]</code> column of the <code>[Media]</code> table. | ||
| + | |||
| + | =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= | =Sample= | ||
Revision as of 16:50, 20 May 2021
This deletes a piece of media from Truxton.
Syntax
uint32_t truxton_delete_media( uint64_t trutxon_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" );
}
