Truxton file get details - Revision history

Sam at 21:27, 10 February 2021

2021-02-10T21:27:20Z

Sam: /* Sample */

2020-06-21T11:54:42Z

Sample

Sam at 08:05, 13 June 2020

2020-06-13T08:05:26Z

Sam at 11:04, 10 June 2020

2020-06-10T11:04:03Z

Sam: /* Sample */

2020-06-07T12:20:58Z

Sample

Sam: Created page with "This retrieves a [https://en.wikipedia.org/wiki/JSON JSON] blob containing details from the file's contents. =Syntax= void truxton_file_get_details..."

2020-06-07T12:19:46Z

Created page with "This retrieves a [https://en.wikipedia.org/wiki/JSON JSON] blob containing details from the file's contents. =Syntax= <syntaxhighlight lang="C"> void truxton_file_get_details..."

New page

This retrieves a [https://en.wikipedia.org/wiki/JSON JSON] blob containing details from the file's contents.

=Syntax=
<syntaxhighlight lang="C">
void truxton_file_get_details( uint64_t file_handle, char * destination_string, size_t max_size )
</syntaxhighlight>

=Parameters=
==<code>file_handle</code>==
The handle created by the [[truxton_file_open_id]] or [[truxton_file_open_md5]] 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>.

=Remarks=
This method only works on files with contents.
It does not work for every file type in Truxton.
But, if it is a supported file type, Truxton will open the file, interpret the contents and output details in JSON format.

=Sample=
<syntaxhighlight lang="C" highlight="12">
int print_id(uint64_t truxton)
{
uint64_t file = truxton_file_open_md5(truxton, "9ec8fb6095c35eff2b236863b7caaf10");

if ( file != 0 )
{
return(0);
}

char json[ 16384 ];

truxton_file_get_depot_name( file, json, sizeof(json));

printf( "%s\n", name_string);
}
</syntaxhighlight>

@@ Line 2: / Line 2: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 void truxton_file_get_details( uint64_t file_handle, char * destination_string, size_t max_size );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 22: / Line 22: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="12">
+<source lang="C" highlight="12">
-void print_id(uint64_t truxton)
+void print_id( uint64_t truxton )
+{
-    uint64_t file = truxton_file_open_md5(truxton, "9ec8fb6095c35eff2b236863b7caaf10");
+    uint64_t file = truxton_file_open_md5( truxton, "9ec8fb6095c35eff2b236863b7caaf10" );
     if ( file != 0 )
@@ Line 34: / Line 34: @@
     char json[ 16384 ];
-    truxton_file_get_file_details(file, json, sizeof(json) );
+    truxton_file_get_file_details( file, json, sizeof(json) );
-    printf( "%s\n", name_string);
+    printf( "%s\n", name_string );
-    truxton_file_free(file);
+    truxton_file_free( file );
+}
-</syntaxhighlight>
+</source>