Download the data in a stored object to a string or byte array buffer.
object.GetData( ObjectLabel, Buffer,
- A string which specifies the label of the object that
should be retrieved from the server.
- This parameter specifies the buffer that will contain the object
data when the method returns. If the variable is a String type, then the data will be
returned as a string of characters. This is the most appropriate
data type to use if the object only contains text. If the
object contains binary data, it is recommended that a Byte
array variable be specified as the argument to this method.
- An optional integer argument that will contain the number of
bytes copied into the buffer when the method returns.
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 GetData method transfers data from a stored object to the
specified buffer. 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.