| |
Transfers data from a local buffer and stores it in a file on the
server.
Syntax
object.PutData( RemoteFile, Buffer,
[Length], [Reserved] )
Parameters
- RemoteFile
- A string that specifies the file on the server that will
contain the data being transferred. If the file already exists, it
will be overwritten. The file pathing and name conventions must be
that of the server.
- Buffer
- This parameter specifies the local buffer that the data will be
copied from. If the variable is a String type, then the data will be
written as a string of characters. This is the most appropriate data
type to use if the file on the server is a text file. If the remote
file should contain binary data, it is recommended that a Byte
array variable be specified as the argument to this method.
- Length
- An optional integer argument that specifies the amount of data
to be copied from the buffer. If this argument is omitted, the
entire contents of the buffer is transferred to the server.
- Reserved
- An argument reserved for future expansion. This argument should
always be omitted or specified as a numeric value of zero.
Return Value
A value of zero is returned if the operation was successful,
otherwise a non-zero error code is returned which indicates the cause
of the failure.
Remarks
The PutData method transfers data from a local buffer and
stores it on a file on the server. This method will cause the current
thread to block until the file 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 progress
bar.
See Also
Priority Property,
GetData Method, GetFile
Method, PutFile Method,
OnProgress Event
|
|