Difference between revisions of "Truxton media set case number"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "Sets the case number of this media object. This corresponds to the <code>CaseNumber</code> column of the <code>Media</code> table. This is an arbitrary string value that Trux...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Sets the case number of this media object.
 
Sets the case number of this media object.
This corresponds to the <code>CaseNumber</code> column of the <code>Media</code> table.
+
This corresponds to the <code>[CaseNumber]</code> column of the <code><nowiki>[</nowiki>[[Media Table|Media]]<nowiki>]</nowiki></code> table.
  
 
This is an arbitrary string value that Truxton will associate with the media.
 
This is an arbitrary string value that Truxton will associate with the media.
 
The format of the case number is whatever the user wishes.
 
The format of the case number is whatever the user wishes.
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
void truxton_media_set_case_number( uint64_t media_handle, char * case_number);
+
void truxton_media_set_case_number( uint64_t media_handle, char const * case_number );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 19: Line 19:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
void set_case(uint64_t media_handle)
+
void set_case( uint64_t media_handle )
 
{
 
{
 
   truxton_media_set_case_number( media_handle, "2020:55:A 14-D" );
 
   truxton_media_set_case_number( media_handle, "2020:55:A 14-D" );
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 07:44, 3 February 2024

Sets the case number of this media object. This corresponds to the [CaseNumber] column of the [Media] table.

This is an arbitrary string value that Truxton will associate with the media. The format of the case number is whatever the user wishes.

Syntax

void truxton_media_set_case_number( uint64_t media_handle, char const * case_number );

Parameters

media_handle

The handle created by the truxton_media_create or truxton_media_open_id call.

case_number

The case number of the media.

Sample

void set_case( uint64_t media_handle )
{
   truxton_media_set_case_number( media_handle, "2020:55:A 14-D" );
}