Difference between revisions of "Truxton file create artifact"
Jump to navigation
Jump to search
(→Sample) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
This creates an artifact from this file that you can use in the [[Truxton C API#Artifacts | Artifact API.]] | This creates an artifact from this file that you can use in the [[Truxton C API#Artifacts | Artifact API.]] | ||
| − | An artifact object is how you add records to the <code>[[Entity Table | Entity]]</code> table. | + | An artifact object is how you add records to the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table. |
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
uint64_t truxton_file_create_artifact( uint64_t file_handle ); | uint64_t truxton_file_create_artifact( uint64_t file_handle ); | ||
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 13: | Line 13: | ||
=Return value= | =Return value= | ||
A handle to an artifact object. | A handle to an artifact object. | ||
| + | |||
| + | =Remarks= | ||
| + | The artifact created by this function will already have the following initialized: | ||
| + | * The [[truxton_artifact_set_file_id|file id]] will be set to this [[truxton_file_get_id|file's id]]. | ||
| + | * The [[truxton_artifact_set_media_id|media id]] will be set to this [[truxton_file_get_media_id|file's media id]]. | ||
| + | * The [[truxton_artifact_set_object_id|object id]] will be set this [[truxton_file_get_id|file's id]]. | ||
| + | * The [[truxton_artifact_set_object_type|object type]] will be set to <code>[[Object Types|OBJECT_TYPE_FILE]]</code> | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="5"> |
| − | void process_file(uint64_t truxton) | + | void process_file( uint64_t truxton ) |
{ | { | ||
| − | uint64_t file = truxton_file_open_md5(truxton, "9ec8fb6095c35eff2b236863b7caaf10"); | + | uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" ); |
| − | uint64_t artifact = truxton_file_create_artifact(file); | + | uint64_t artifact = truxton_file_create_artifact( file ); |
| − | truxton_artifact_set_type(artifact, ENTITY_TYPE_SERIAL_NUMBER); | + | truxton_artifact_set_type( artifact, ENTITY_TYPE_SERIAL_NUMBER ); |
| − | truxton_artifact_set_value(artifact, "1234" ); | + | truxton_artifact_set_value( artifact, "1234" ); |
| − | truxton_artifact_save(artifact); | + | truxton_artifact_save( artifact ); |
| − | truxton_artifact_destroy(artifact); | + | truxton_artifact_destroy( artifact ); |
| − | truxton_file_free(file); | + | truxton_file_free( file ); |
} | } | ||
| − | </ | + | </source> |
Latest revision as of 07:02, 10 February 2021
This creates an artifact from this file that you can use in the Artifact API.
An artifact object is how you add records to the [Entity] table.
Syntax
uint64_t truxton_file_create_artifact( uint64_t file_handle );
Parameters
file_handle
The handle created by the truxton_file_open_id or truxton_file_open_md5 call.
Return value
A handle to an artifact object.
Remarks
The artifact created by this function will already have the following initialized:
- The file id will be set to this file's id.
- The media id will be set to this file's media id.
- The object id will be set this file's id.
- The object type will be set to
OBJECT_TYPE_FILE
Sample
void process_file( uint64_t truxton )
{
uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" );
uint64_t artifact = truxton_file_create_artifact( file );
truxton_artifact_set_type( artifact, ENTITY_TYPE_SERIAL_NUMBER );
truxton_artifact_set_value( artifact, "1234" );
truxton_artifact_save( artifact );
truxton_artifact_destroy( artifact );
truxton_file_free( file );
}
