Truxton jurisdiction get description - Revision history

Sam: Created page with "This retrieves the description of the jurisdiction. This corresponds to the `[Description]` column of the `[Jurisdiction]` table. =Syntax=
2021-02-18T20:17:33Z

Created page with "This retrieves the description of the jurisdiction. This corresponds to the <code>[Description]</code> column of the <code>[Jurisdiction]</code> table. =Syntax= <source lang=..."

New page
This retrieves the description of the jurisdiction.
This corresponds to the <code>[Description]</code> column of the <code>[Jurisdiction]</code> table.

=Syntax=
<source lang="C">
void truxton_jurisdiction_get_description( uint64_t jurisdiction_handle, char * destination_string, size_t maximum_size );
</source>

=Parameters=
==<code>jurisdiction_handle</code>==
The handle to the file type object.
This handle comes from calling <code>[[truxton_jurisdiction_create|truxton_jurisdiction_create()]]</code>.

==<code>destination_string</code>==
The string buffer where the description will go.

==<code>maximum_size</code>==
The size of the <code>destination_string</code> buffer.
The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.]

=Sample=
<source lang="C" highlight="12">
void dump( uint64_t jurisdiction )
{
char temporary_string[ 256 ];

uint64_t id= truxton_jurisdiction_get_id( jurisdiction );

printf( "ID: %" PRIu64 "\n", id );

truxton_jurisdiction_get_name( jurisdiction, temporary_string, sizeof( temporary_string ) );
printf( "Name: %s\n", temporary_string );

truxton_jurisdiction_get_description( jurisdiction, temporary_string, sizeof( temporary_string ) );
printf( "Description: %s\n", temporary_string );
}
</source>

The <code>PRIu64</code> in the sample code above is a standard way of [https://en.wikipedia.org/wiki/C_data_types#Printf_and_scanf_format_specifiers formatting] a 64-bit unsigned integer in C.
Over the years, different compilers on different operating systems used different format specifiers for things, these <code>PRI</code> macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.