FileRename - Revision history

Lettify: Portuguese version indexed

2023-12-20T19:51:00Z

Portuguese version indexed

← Older revision		Revision as of 19:51, 20 December 2023
Line 36:		Line 36:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
			[[pt-br:fileRename]]

Danilo at 05:52, 11 August 2019

2019-08-11T05:52:15Z

← Older revision		Revision as of 05:52, 11 August 2019
Line 3:		Line 3:

	Renames the specified file.		Renames the specified file.
			{{Note\|Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.}}
	~~'''~~Note~~:'''~~ Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.

	==Syntax==		==Syntax==

Strix: add oop syntax

2015-01-02T20:40:28Z

add oop syntax

← Older revision		Revision as of 20:40, 2 January 2015
Line 7:		Line 7:

	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool fileRename ( string filePath, string newFilePath )		bool fileRename ( string filePath, string newFilePath )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is a static function underneath the File class.\|[[File]].rename}}
	===Required Arguments===		===Required Arguments===
	*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.		*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
	*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.		*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.

	~~</section>~~

	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">~~
	~~bool fileRename ( string filePath, string newFilePath )~~
	~~</syntaxhighlight>~~

	~~===Required Arguments===~~
	*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
	*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.
	~~</section>~~

	===Returns===		===Returns===

Ccw at 12:01, 13 September 2011

2011-09-13T12:01:02Z

← Older revision		Revision as of 12:01, 13 September 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}

	Renames the specified file.		Renames the specified file.

Ccw at 23:41, 16 July 2011

2011-07-16T23:41:53Z

← Older revision		Revision as of 23:41, 16 July 2011
Line 20:		Line 20:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool fileRename ( string filePath, string newFilePath ~~[, string accessType = "public" ]~~ )		bool fileRename ( string filePath, string newFilePath )
	</syntaxhighlight>		</syntaxhighlight>

Line 26:		Line 26:
	*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.		*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
	*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.		*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.

	~~===Optional Arguments===~~
	*'''accessType :''' This setting determines whether the public or private version of the file will be renamed.
	** "public" will rename the file that is shared by all servers.
	** "private" will rename the file that only the current server is allowed to access. Note: It is only possible to rename a private file if it was previously saved as ''"private"'' by the current server.
	</section>		</section>

Ccw: /* Syntax */

2011-06-01T13:29:11Z

Syntax

@@ Line 7: / Line 7: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
 bool fileRename ( string filePath, string newFilePath )
@@ Line 14: / Line 15: @@
 *'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
 *'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.
 ===Returns===

MX Master: new page for new fileRename function

2011-04-26T13:28:44Z

new page for new fileRename function

New page

__NOTOC__
{{Server function}}

Renames the specified file.

'''Note:''' Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.

==Syntax==
<syntaxhighlight lang="lua">
bool fileRename ( string filePath, string newFilePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.

===Returns===
If successful, returns ''true''. Otherwise returns ''false''.

==Example==
This example renames the file ''test1.txt'' that is in the root of the current resource to ''test2.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "test2.txt" ) then
outputConsole("File `test1.txt` successfully renamed to `test2.txt`")
else
outputConsole("Unable to rename `test1.txt`")
end</syntaxhighlight>

This example moves the file ''test1.txt'' that is in the root of the current resource to ''myFolder'' folder. If this folder is not exists, it will be created before moving the file ''test1.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "myFolder/test1.txt" ) then
outputConsole("File `test1.txt` successfuly moved to `myFolder` folder")
else
outputConsole("Unable to move `test1.txt`")
end</syntaxhighlight>

==See Also==
{{File functions}}