Quiret at 23:48, 16 January 2022

2022-01-16T23:48:10Z

← Older revision		Revision as of 23:48, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int file~~.size~~ ()		int file:tell ()
	</syntaxhighlight>		</syntaxhighlight>

Line 16:		Line 16:
	local function alternativeFileReset( theFile )		local function alternativeFileReset( theFile )
	-- Get the current stream position.		-- Get the current stream position.
	local streamOffset = theFile.tell();		local streamOffset = theFile:tell();

	-- Check whether this operation is supported.		-- Check whether this operation is supported.
Line 24:		Line 24:

	-- Reset the file to its beginning.		-- Reset the file to its beginning.
	theFile.seek( -streamOffset, "cur" );		theFile:seek( -streamOffset, "cur" );
	return true;		return true;
	end		end

The GTA: 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 b..."

2014-01-31T14:40:24Z

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 b..."

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.size ()
</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>
{{:MTA:Eir/FileSystem/file/functions}}

MTA:Eir/FileSystem/file/tell - Revision history

Quiret at 23:48, 16 January 2022

The GTA: 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 b..."

The GTA: 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 b..."