Difference between revisions of "Truxton media set description"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "Sets the description of this media object. This corresponds to the <code>Description</code> column of the <code>Media</code> table. =Syntax= <syntaxhighlight lang="C"> void t...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Sets the description of this media object.
 
Sets the description of this media object.
This corresponds to the <code>Description</code> column of the <code>Media</code> table.
+
This corresponds to the <code>[Description]</code> column of the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table.
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
void truxton_media_set_description( uint64_t media_handle, char * description );
+
void truxton_media_set_description( uint64_t media_handle, char const * description );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 17: Line 17:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
void set_description(uint64_t media_handle)
+
void set_description( uint64_t media_handle )
 
{
 
{
 
   truxton_media_set_description( media_handle, "Thumb drive found at the scene" );
 
   truxton_media_set_description( media_handle, "Thumb drive found at the scene" );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 07:44, 3 February 2024

Sets the description of this media object. This corresponds to the [Description] column of the [Media] table.

Syntax

void truxton_media_set_description( uint64_t media_handle, char const * description );

Parameters

media_handle

The handle created by the truxton_media_create or truxton_media_open_id call.

description

The description of the media.

Sample

void set_description( uint64_t media_handle )
{
   truxton_media_set_description( media_handle, "Thumb drive found at the scene" );
}