Truxton file readline - Revision history

Sam at 21:35, 10 February 2021

2021-02-10T21:35:31Z

Sam at 10:57, 10 June 2020

2020-06-10T10:57:53Z

Sam at 13:05, 6 June 2020

2020-06-06T13:05:51Z

Sam: Created page with "This will read a single line from the file contents. =Syntax= int64_t truxton_file_readline( uint64_t file_handle, uint8_t * buffer, size_t buffer_..."

2020-06-03T14:38:11Z

Created page with "This will read a single line from the file contents. =Syntax= <syntaxhighlight lang="C"> int64_t truxton_file_readline( uint64_t file_handle, uint8_t * buffer, size_t buffer_..."

New page

This will read a single line from the file contents.

=Syntax=
<syntaxhighlight lang="C">
int64_t truxton_file_readline( uint64_t file_handle, uint8_t * buffer, size_t buffer_size, int64_t limit )
</syntaxhighlight>

=Parameters=
==<code>file_handle</code>==
The handle created by the [[truxton_file_open_id]] of [[truxton_file_open_md5]] call.

==<code>buffer</code>==
The memory where the bytes will be written.

==<code>buffer_size</code>==
The number of bytes that can be written to <code>buffer</code>.

==<code>limit</code>==
The maximum number of bytes to write to <code>buffer</code>.

=Return value=
The number of bytes written to <code>buffer</code> on success, -1 on error.
This can be less than <code>buffer_size</code> if the line read is smaller than <code>buffer_size</code> or if the <code>limit</code> parameter is less than <code>buffer_size</code>.

=Sample=

<syntaxhighlight lang="C" highlight="14">
void print_line(uint64_t truxton)
{
uint64_t file = truxton_file_open_id(truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000");

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

char line_of_text[ 256 ];

memset( line_of_text, 0x00, sizeof( line_of_text ) );

if ( truxton_file_readline( file, line_of_text, sizeof( line_of_text ), sizeof( line_of_text ) - 1 ) >= 0 )
{
// We succeeded in reading a line of text
printf( "%s\n", line_of_text );
}

truxton_file_free(file);
}
</syntaxhighlight>

@@ Line 2: / Line 2: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 int64_t truxton_file_readline( uint64_t file_handle, uint8_t * buffer, size_t buffer_size, int64_t limit );
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 24: / Line 24: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="14">
+<source lang="C" highlight="14">
-void print_line(uint64_t truxton)
+void print_line( uint64_t truxton )
+{
-    uint64_t file = truxton_file_open_id(truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000");
+    uint64_t file = truxton_file_open_id( truxton, "5ed3aeb7-3da4-5f5c-8c8f-af5200000000" );
     if ( file != 0 )
+    {
-       return(0);
+       return( 0 );
+    }
@@ Line 44: / Line 44: @@
+    }
-    truxton_file_free(file);
+    truxton_file_free( file );
+}
-</syntaxhighlight>
+</source>

@@ Line 8: / Line 8: @@
 =Parameters=
 ==<code>file_handle</code>==
-The handle created by the [[truxton_file_open_id]] of [[truxton_file_open_md5]] call.
+The handle created by the [[truxton_file_open_id]] or [[truxton_file_open_md5]] call.
 ==<code>buffer</code>==