FileCopy

Copies a file

Syntax
	KeyPgDeclareDeclare KeyPgFunctionFunction FileCopy ( KeyPgByvalByVal source KeyPgAsAs KeyPgZstringZString KeyPgPtrPtr, KeyPgByvalByVal 
	destination KeyPgAsAs KeyPgZstringZString KeyPgPtrPtr ) KeyPgAsAs KeyPgLongLong

Usage
	#include "file.bi"
	FileCopy source, destination

or

	#include "file.bi"
	result = FileCopy( source, destination )

Parameters
	source
		A KeyPgStringString argument specifying the filename of the file to copy from.  
		This file must exist.
	destination
		A KeyPgStringString argument specifying the filename of the file to copy to.  
		This file will be overwritten if it exists.  This file should not be 
		currently referenced by any open file handles.

Return Value
	Returns 0 on success, or 1 if an error occurred.

Description
	Copies the contents of the source file into the destination file, 
	overwriting the destination file if it already exists.
	It is necessary to KeyPgInclude#include either "file.bi" or "vbcompat.bi" in order 
	to gain access to this function.

	The error code returned by FileCopy can be checked using KeyPgErrErr in the next 
	line. The function version of  FileCopy returns directly the error code 
	as a 32 bit KeyPgLongLong.

Example
	#include "file.bi"
	FileCopy "source.txt", "destination.txt"

Platform Differences
	* Linux requires the filename case matches the real name of the file. 
	  Windows and DOS are case insensitive. 
	* Path separators in Linux are forward slashes /. Windows uses backward 
	  slashes \ but it allows forward slashes.  DOS uses backward  slashes \
	  . 

Differences from QB
	* New to FreeBASIC.  Existed in Visual Basic.

See also

