<< Click to Display Table of Contents >> Navigation: ThinBASIC Modules > File > FILE: functions working on files > FILE_ShellCopy |
Description
Copy a file from one place to another using operating system file intrinsic operations.
Syntax
n = FILE_ShellCopy(FileName_Source, FileName_Destination)
Returns
Number. Zero if successful, otherwise nonzero.
Parameters
Name |
Type |
Optional |
Meaning |
FileName_Source |
String |
No |
A string representing one or more source file names. These names should be fully-qualified paths to prevent unexpected results. Standard Microsoft MS-DOS wildcard characters, such as "*", are permitted only in the file-name position. Using a wildcard character elsewhere in the string will lead to unpredictable results.
Although this member is declared as a single string, it is actually a buffer that can hold multiple null-delimited file names. Each file name is terminated by a single $NUL character. The last file name is automatically terminated with a double $NUL character by thinBasic to indicate the end of the buffer. |
FileName_Destination |
String |
No |
A string representing one or more destination file names. These names should be fully-qualified paths to prevent unexpected results. Standard Microsoft MS-DOS wildcard characters, such as "*", are permitted only in the file-name position. Using a wildcard character elsewhere in the string will lead to unpredictable results.
Although this member is declared as a single string, it is actually a buffer that can hold multiple null-delimited file names. Each file name is terminated by a single $NUL character. The last file name is automatically terminated with a double $NUL character by thinBasic to indicate the end of the buffer. |
Remarks
Number of $NUL terminated strings must match in source and destination parameters.
Restrictions
See also
Examples