CopyFileProgress
Description: |
baCopyFileProgress copies a file, while displaying a progress dialog. | |||||||||||||||||||||
Platforms: |
Windows and Macintosh | |||||||||||||||||||||
Usage: |
Result = baCopyFileProgress( SourceFile , DestFile , Overwrite, Title, ButtonText, Flags ) | |||||||||||||||||||||
Arguments: |
String, string, string, string, string, integer.
ButtonText is the text to use in the Cancel button. Flags changes the behaviour of the dialog, see notes for details. |
|||||||||||||||||||||
Returns: |
Integer.
|
|||||||||||||||||||||
Examples: |
Director: Authorware: |
|||||||||||||||||||||
Notes: |
By default, this function will not overwrite an existing file if that file is marked as read-only. However, by adding "+" to the "Always" and "IfNewer" options (eg "Always+" or "IfNewer+"), the files will be overwritten if they are read-only. The return value will not be 0 if any file is not copied. For example, if you specify On Windows, the FileSpec argument follows normal DOS wildcard rules. A * means match any character in the file name. So *.* copies all files; *.bmp copies all files with a .bmp extension; T*.* copies all files starting with the letter T. On Macintosh, the FileSpec is either a four character type code eg "TEXT" or an extension eg ".txt". Only one type or extension can be specified. Use an empty string or "*.*" to match all files. A return value of 6 (Dest file exists) can only be returned when Overwrite is "IfNotExist". A return value of 7 (Dest file is newer than Source file) can only be returned when Overwrite is "IfNewer". The other return values can be returned for all Overwrite options. The "IfNewer" option operates as follows: if both files have internal version numbers, then these numbers are used for comparison, otherwise the dates of the two files are used for comparison. Seven Flags are defined:
You can add any of these flags together to customize the dialog box. To implement the callback handler, use the CP_CALLBACK flag. Typically you would also use the CP_NODIALOG flag and implement your own dialog box. If you use this flag then you need to add a handler called 'baCopyProgressUpdate'. This handler needs to be a movie script. This handler will have two arguments passed into it - the percentage copied so far and the current file being copied. The handler will be called whenever the percentage copied has increased by one, or a new file is being copied. If you specify the CP_SIZEUPDATE, then your handler will be called whenever approximately 64k of data has been copied, rather than by percentage. To stop copying, you can return 1 in your handler; return 0 or no return to continue copying. An example handler is listed below - the update functions would be used to update your own progress dialog. on baCopyProgressUpdate percentage, filename The callback handler is only available on Director.
|
|||||||||||||||||||||
See also: |
baCopyFile |