Modules/FileSystem/file/tell - Revision history

Danilo at 03:11, 23 January 2022

2022-01-23T03:11:24Z

← Older revision		Revision as of 03:11, 23 January 2022
Line 1:		Line 1:
			<pageclass class="#3cc882" subcaption="File function"></pageclass>
	__NOTOC__		__NOTOC__
	This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation.		This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation.

Quiret: /* Example */

2022-01-20T22:51:08Z

Example

← Older revision		Revision as of 22:51, 20 January 2022
Line 11:		Line 11:

	==Example==		==Example==
	<section name="Server" class="~~client~~" show="true">		<section name="Server" class="server" show="true">
	This snippet seeks back to the beginning of the file by going back the current stream pointer byte offset.		This snippet seeks back to the beginning of the file by going back the current stream pointer byte offset.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Quiret: /* Example */

2022-01-20T22:50:51Z

Example

← Older revision		Revision as of 22:50, 20 January 2022
Line 11:		Line 11:

	==Example==		==Example==
	<section name="~~Client~~" class="client" show="true">		<section name="Server" class="client" show="true">
	This snippet seeks back to the beginning of the file by going back the current stream pointer byte offset.		This snippet seeks back to the beginning of the file by going back the current stream pointer byte offset.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Danilo: Created page with "NOTOC This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation. ==Syntax== int file:tell () ==Returns== Returns the amount of bytes that this file/stream object has already traversed. If the operation is not supported by the underly..."

2022-01-19T03:46:41Z

Created page with "__NOTOC__ This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation. ==Syntax== <syntaxhighlight lang="lua"> int file:tell () </syntaxhighlight> ==Returns== Returns the amount of bytes that this file/stream object has already traversed. If the operation is not supported by the underly..."

New page

__NOTOC__
This function returns the current absolute position inside of the file/stream object. It should be the number of bytes that the current stream pointer is set from the beginning of the object. Not all stream classes have to support this operation.

==Syntax==
<syntaxhighlight lang="lua">
int file:tell ()
</syntaxhighlight>

==Returns==
Returns the amount of bytes that this file/stream object has already traversed. If the operation is not supported by the underlying stream class, it returns '''false'''.

==Example==
<section name="Client" class="client" show="true">
This snippet seeks back to the beginning of the file by going back the current stream pointer byte offset.
<syntaxhighlight lang="lua">
local function alternativeFileReset( theFile )
-- Get the current stream position.
local streamOffset = theFile:tell();

-- Check whether this operation is supported.
if not ( streamOffset ) then
return false, "not supported";
end

-- Reset the file to its beginning.
theFile:seek( -streamOffset, "cur" );
return true;
end
</syntaxhighlight>
</section>
{{:Modules/FileSystem/file/functions}}