IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

DownloadType Property

The download type to use for file resources.

Syntax

ANSI (Cross Platform)
int GetDownloadType();
int SetDownloadType(int iDownloadType); Unicode (Windows) INT GetDownloadType();
INT SetDownloadType(INT iDownloadType);

Possible Values

BDT_FILE_CONTENT(0), 
BDT_FILE_THUMBNAIL(1)
@property (nonatomic,readwrite,assign,getter=downloadType,setter=setDownloadType:) int downloadType;
- (int)downloadType;
- (void)setDownloadType:(int)newDownloadType;

Possible Values

BDT_FILE_CONTENT(0), 
BDT_FILE_THUMBNAIL(1)
#define PID_BOX_DOWNLOADTYPE 15

IPWORKSCLOUD_EXTERNAL void* IPWORKSCLOUD_CALL IPWorksCloud_Box_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_Box_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

This property controls what the class will download when DownloadFile is called for a file resource. Possible values are:

0 (bdtFileContent - default) DownloadFile will download the file's contents.
1 (bdtFileThumbnail) DownloadFile will download a thumbnail of the file.

File thumbnails may be customized using the ThumbnailFormat and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.

If Box is still in the process of generating the requested thumbnail when this method is called, the class will populate the RetryAfter configuration setting and throw an exception. Retry the request after the number of seconds indicated by RetryAfter.

This property is not available at design time.

Data Type

Integer

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