StartByte Property

The offset in bytes at which to begin the Upload or Download.

Syntax

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);
@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;
- (long long)startByte;
- (void)setStartByte:(long long)newStartByte;

#define PID_SFTP_STARTBYTE 51

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SFTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SFTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting in order to only download a specific range of data from the current RemoteFile.

Data Type

Long64
Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Edition - Version 20.0 [Build 8501]