Difference between revisions of "Truxton media get description"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
This retrieves the description of the media. | This retrieves the description of the media. | ||
| − | It corresponds to the <code>[Description]</code> column of the <code>[Media]</code> table. | + | It corresponds to the <code>[Description]</code> column of the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table. |
=Syntax= | =Syntax= | ||
Latest revision as of 07:43, 3 February 2024
This retrieves the description of the media.
It corresponds to the [Description] column of the [Media] table.
Syntax
void truxton_media_get_description( uint64_t media_handle, char * destination_string, size_t max_size );
Parameters
media_handle
The handle created by the truxton_media_create or truxton_media_open_id call.
destination_string
The string to be written to.
max_size
The maximum number of characters that can be written to destination_string.
Sample
void print_description( uint64_t truxton )
{
uint64_t media = truxton_media_open_id( truxton, "150929ce-bf30-4d5d-08d9-b48a0806c843" );
if ( media != 0 )
{
return;
}
char description[ MAX_PATH ];
truxton_media_get_description( media, description, sizeof(description) );
printf( "Description is %s\n", description );
truxton_media_free( media );
}