Range Property

The range of bytes to request.

Syntax

ANSI (Cross Platform)
char* GetRange();
int SetRange(const char* lpszRange); Unicode (Windows) LPWSTR GetRange();
INT SetRange(LPCWSTR lpszRange);
@property (nonatomic,readwrite,assign,getter=range,setter=setRange:) NSString* range;
- (NSString*)range;
- (void)setRange:(NSString*)newRange;
#define PID_S3CLIENT_RANGE 66

IPWORKSS3_EXTERNAL void* IPWORKSS3_CALL IPWorksS3_S3Client_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSS3_EXTERNAL int IPWORKSS3_CALL IPWorksS3_S3Client_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

  • StartByte-
  • StartByte-EndByte

Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S3 2020 C++ Edition - Version 20.0 [Build 8164]