StartByte Property

The byte index in RemoteFile and LocalFile from which to start the transmission.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

ipworks_ftp_get($res, 30 );
ipworks_ftp_set($res, 30, $value );

Default Value

'0'

Remarks

This property contains a zero-based index in both RemoteFile and LocalFile that determines the point where the transmission of data starts from. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the StartByte index is used for all future downloads/uploads. The property must be reset to "0" for normal downloads/uploads.

The type of the property is a string instead of numeric to allow for certain implementations that expect an alphanumeric marker of the start index.

In the Transfer event, the TransferredBytes parameter will include the bytes skipped (i.e. it will show StartByte more bytes than actually transferred).

NOTE: some FTP servers may not support the FTP 'REST' command. If that is the case with the server you are accessing, you will not be able to use the StartByte property.

This property is not available at design time.

Data Type

String