Truxton artifact get id - Revision history

Sam at 15:11, 10 February 2021

2021-02-10T15:11:37Z

Sam: /* Sample */

2021-02-06T11:17:09Z

Sample

Sam at 13:15, 14 December 2020

2020-12-14T13:15:34Z

Sam at 13:47, 10 November 2020

2020-11-10T13:47:26Z

Sam: /* artifact_handle */

2020-11-06T11:00:10Z

artifact_handle

Sam: Created page with "This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from. This corresponds to the `[ID]` column of..."

2020-11-03T19:12:34Z

Created page with "This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from. This corresponds to the <code>[ID]</code> column of..."

New page

This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from.
This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
If you created this artifact, the identifier only becomes available after you have called <code>[[truxton_artifact_save]]</code>.

=Syntax=
<source lang="C">
void truxton_artifact_get_id( uint64_t artifact_handle, char * destination_string, size_t max_size );
</source>

=Parameters=
==<code>artifact_handle</code>==
The handle to a message created by the [[truxton_artifact_create]] call.

==<code>destination_string</code>==
The string to be written to.

==<code>max_size</code>==
The maximum number of characters that can be written to <code>destination_string</code>.

=Sample=

<source lang="C" highlight="14">
void dump_artifact(uint64_t artifact_handle)
{
char guid_string[ 40 ];

truxton_artifact_get_file_id( artifact_handle, guid_string, sizeof(guid_string) );
printf( "File ID is %s\n", guid_string );

truxton_artifact_get_media_id( artifact_handle, guid_string, sizeof(guid_string) );
printf( "Media ID is %s\n", guid_string );

truxton_artifact_get_object_id( artifact_handle, guid_string, sizeof(guid_string) );
printf( "Object ID is %s\n", guid_string );

truxton_artifact_get_id( artifact_handle, guid_string, sizeof(guid_string) );
printf( "Artifact ID is %s\n", guid_string );

uint64_t value = truxton_artifact_get_object_type( artifact_handle );
printf( "Object type is %" PRIu64 "\n", value );

value = truxton_artifact_get_data_type( artifact_handle );
printf( "Data type is %" PRIu64 "\n", value );

value = truxton_artifact_get_offset( artifact_handle );
printf( "Offset is %" PRIu64 "\n", value );

value = truxton_artifact_get_length( artifact_handle );
printf( "Length is %" PRIu64 "\n", value );

value = truxton_artifact_get_type( artifact_handle );
printf( "Type is %" PRIu64 "\n", value );
}
</source>

← Older revision		Revision as of 11:17, 6 February 2021
Line 52:		Line 52:
	}		}
	</source>		</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.

@@ Line 20: / Line 20: @@
 =Sample=
 <source lang="C" highlight="14">
-void dump_artifact(uint64_t artifact_handle)
+void dump_artifact( uint64_t artifact_handle )
+{
     char guid_string[ 40 ];

@@ Line 1: / Line 1: @@
-This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this artifact came from.
+This retrieves the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the artifact.
 This corresponds to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table.
 If you created this artifact, the identifier only becomes available after you have called <code>[[truxton_artifact_save]]</code>.

@@ Line 10: / Line 10: @@
 =Parameters=
 ==<code>artifact_handle</code>==
-The handle to a message created by the [[truxton_artifact_create]] call.
+The handle to an artifact created by the [[truxton_artifact_create]] call.
 ==<code>destination_string</code>==