Download the data in a stored object to a local file.
object.GetFile( LocalFile, ObjectLabel )
- A string which specifies the name of the local file that will be
created or overwritten with the contents of the storage object. If a
path is not specified, the file will be created in the current
- A string which specifies specifies the label of the object that
should be retrieved from the server.
A value of True is returned on success.
If an error occurs, a value of False is returned and the LastError
property will return the specific cause of the failure..
The GetFile method downloads data from a stored object to a
local file. This method will cause the current thread to block until
the data transfer completes, a timeout occurs or the transfer is canceled.
During the transfer, the OnProgress event will fire periodically,
enabling the application to update any user interface objects such as a
When this method returns, various properties such as ObjectId
and ObjectLabel will be updated to reflect the values
associated with the object that was downloaded from the server.