Truxton artifact get data type

From truxwiki.com
Jump to navigation Jump to search

This tells you what the underlying data type was for the artifact. This information comes from the [DataTypeID] column of the [Entity] table in the database or a defined constant.

Syntax

uint64_t truxton_artifact_get_data_type( uint64_t artifact_handle );

Parameters

artifact_handle

The artifact instance. This handle comes from calling truxton_artifact_create().

Return value

The data type of the raw artifact. This corresponds to the [ID] column of the [DataType] table. It can also be one of the defined constants.

Sample

void create_artifact(void)
{
   uint64_t truxton = truxton_create();

   uint64_t artifact = truxton_artifact_create( truxton );

   truxton_artifact_set_name( artifact, "Ducky Momo Server" );
   truxton_artifact_save( artifact );
   truxton_artifact_tag( artifact, "Too Young", "Yes, yes I am", 1 );

   uint64_t data_type = truxton_artifact_get_data_type( artifact );

   printf( "Artifact raw data type is %" PRIu64 "\n", data_type );

   truxton_artifact_destroy( artifact );
   truxton_destroy( truxton );
}

The PRIu64 in the sample code above is a standard way of formatting a 64-bit unsigned integer in C. Over the years, different compilers on different operating systems used different format specifiers for things, these PRI 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.

Retrieved from "https://truxwiki.com/index.php?title=Truxton_artifact_get_data_type&oldid=3895"