File Transfer Control Properties

The following properties are attached to the File Transfer object. Properties can be read or written. There are no write-only properties. Properties that are read-only are marked R in the following table. Properties that are read or write are also marked in the table.

Property	Access	Description
AddressFamily	Read/ Write	Returns or sets the address family of the File Transfer object.
CurrentFileAttributes	Read Only	Returns the attributes of the current file.
CurrentFilePath	Read Only	Returns the current file path.
CurrentFileSize	Read Only	Returns the size of the current file in bytes.
DestinationFilePath	Read Only	Returns the destination file path of the file transfer.
EndpointAddress	Read Only	Returns the destination address of the file transfer.
EndpointPort	Read Only	Returns the destination port of the file transfer.
FullyReliableService	Read/ Write	Returns or sets the status of the Fully Reliable service.
FullyReliableServiceUsed	Read Only	Returns a value indicating whether a transfer is using the Fully Reliable service.
LocalAddress	Read/ Write	Returns or sets the local address of the File Transfer object.
LocalPort	Read/ Write	Returns or sets the local port of the File Transfer object.
LocalPortUsed	Read Only	Returns the local port used for the last file transfer.
MaxReceiveBufferSize	Read/ Write	Returns or sets the maximum receive buffer size of the File Transfer object in bytes.
NumBogusPacketsReceived	Read Only	Returns the number of bogus packets received.
NumDirectoriesTransferred	Read Only	Returns the number of directory structures transferred.
NumDuplicatePacketsReceived	Read Only	Returns the number of duplicate packets received.
NumFileDataBytesTransferred	Read Only	Returns the amount of file data transferred for the current file, in bytes.
NumFilesTransferred	Read Only	Returns the number of files transferred.
NumPacketsCorrected	Read Only	Returns the number of packets received and corrected.
NumPacketsDropped	Read Only	Returns the number of packets dropped.
NumPacketsTransferred	Read Only	Returns the number of packets transferred.
NumTotalBytesTransferred	Read Only	Returns the total number of bytes for all files transferred, including file header bytes or other non-data file information.
NumTotalDataBytesTransferred	Read Only	Returns the total amount of data for all files transferred, in bytes. Excludes file header bytes or other non-data file information.
Param	Read Only	Returns a value used by the caller to identify transfer notification requests.
PercentFileDataBytesTransferred	Read Only	Returns the percentage of the number of file data bytes transferred.
Protocol	Read/ Write	Returns or sets the protocol of the File Transfer object.
ReceiveTimeout	Read/ Write	Returns or sets the receive timeout of the File Transfer object.
Result	Read Only	Returns the result of a file transfer operation.
SourceAddress	Read Only	Returns the source address of the file transfer.
SourceFilePath	Read Only	Returns the source file path of the file transfer.
SourcePort	Read Only	Returns the source port of the file transfer.
TransferOperation	Read Only	Returns the transfer operation for the File Transfer object.
TransferStatus	Read Only	Returns the status of the File Transfer object.
Type	Read/ Write	Returns or sets the type of File Transfer object.
ValidateReceivedPackets	Read/ Write	Returns or sets a value that indicates whether the user wants to validate incoming packets to ensure that they are for the current transfer.

Important

If a file transfer has not started, then transfer progress properties with read-only access return a value of -1 for numeric properties, and a null string (“”) for string properties. If a transfer starts but then fails before any data is transferred, read-only transfer progress properties return a value of 0 for numeric properties, and a null string (“”) for string properties. These latter null values indicate that a transfer was initiated, but did not actually start.

Previous

Next