ShareFile Class

Properties   Methods   Events   Config Settings   Errors  

The ShareFile class makes it easy to upload, download, and manage files, folders, and share links within ShareFile.

Syntax

ShareFile

Remarks

The ShareFile class provides a simple interface for working with ShareFile. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying items, creating request and send links, and more.

Authentication

The class has the following default:

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Referencing and Creating Items, Links, Permissions, and Users

ShareFile typically uses specified ids to reference its objects. When an object is created, through methods such as CreateClient or CreateFolder or uploaded with the UploadFile method; the class will return with the objects ShareFile Id in the form of a string. In certain cases, a path (/parentFolder/ChildFolder) can be used to reference an item.

When a link is created using methods like CreateAndEmailLink , CreateAndEmailRequestLink, CreateLink, or CreateRequestLink then their URL is returned rather than their ShareFile id. To get the newly created id, the class also clears and populates the Links* properties with the new link. When creating a link, you can use the CreateLinkOptions* properties to set certain options for the link.

When a permission is created using the CreatePermission method, the class will not return anything as ShareFile uses a combination of a UserId and the ItemId of a folder to reference permissions. When creating a permission, you can use the CreatePermissionOptions* properties to set certain options for the permission.

Listing and Getting Items, Links, Permissions, and Users

When listing out the Links and Users currently available to the authenticated user you will use the corresponding ListLinks and ListUsers methods. Both of these methods take no parameters and will populates their corresponding properties. For links the properties is the Links* properties and for users it is the Users* properties.

When listing the Items within a Folder or Permissions, the corresponding methods will take a folders ItemId. ListItems will list the items in the folder to the Items* properties. The method will not recursively list out items found in child folders. The ListPermissions method will list all the permissions for the specified folder to the Permissions* properties.

The class can also list out the items associated with a specified link. The ListLinkItems method will take a LinkId and populate Items* properties.

The class also offers the ability to get the specific information about a certain item, link, permission, or user. GetItemInfo, GetLinkInfo and GetUserInfo each take a corresponding id. For permissions, GetPermissionInfo will take a FolderId and UserId rather than a specific id. Once called, they each clear and populate the corresponding properties.

For all list* and get* methods, there is a corresponding event that will fire for each item in the list. The ItemList event will fire when the ListItems, ListLinkItems, or GetItemInfo methods are called; the LinkList event will fire when the ListLinks or GetLinkInfo methods are called; the PermissionList event will fire when the ListPermissions or GetPermissionInfo methods are called; and the UserList event will fire when the ListUsers or GetUserInfo methods are called.

Downloading Files

The DownloadFile method downloads file or folder items.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ItemData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

Simple Download

A simple download is consistent with setting the LocalFile to the destination of the file when it is downloaded and then calling the method with the item's id. For example: shareFile.LocalFile = "../MyFile.zip"; shareFile.DownloadFile(shareFile.Items[0].Id);

Streaming Download

To download to a stream, first call the SetDownloadStream method and then call the DownloadFile method. For example: shareFile.LocalFile = ""; using (FileStream fs = new FileStream("../../temp/temp_data1.zip", FileMode.OpenOrCreate)) { shareFile.SetDownloadStream(fs); shareFile.DownloadFile(id); }

Uploading Files

The UploadFile method uploads new file items.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ItemData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

ShareFile offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. Once called and the class fragments the file, the ResumeURL property is populated. This URL needs to be set so that the class can resume the upload if the upload is interrupted.

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. shareFile.UseResumableUpload = true; shareFile.LocalFile = "../MyFile.zip"; shareFile.UploadFile("MyFile.zip"); // The transfer is interrupted and UploadFile() above fails. Later, resume the download. // Using the same instance StartByte and ResumeURL are already populated from the previous // upload attempt. shareFile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); shareFile.UseResumableUpload = true; shareFile.SetUploadStream(uploadStream); shareFile.UploadFile("MyFile.zip"); // The transfer is interrupted and UploadFile() above fails. Later, resume the download. // Using the same instance StartByte and ResumeURL are already populated from the previous // upload attempt. // You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; shareFile.UploadFile("MyFile.zip");

Additional Functionality

The ShareFile class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyItem and MoveItem.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccountSubdomain Property (ShareFile Class)

Represent a ShareFile domain for the account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountSubdomain();
int SetAccountSubdomain(const char* lpszAccountSubdomain);

Unicode (Windows)
LPWSTR GetAccountSubdomain();
INT SetAccountSubdomain(LPCWSTR lpszAccountSubdomain);

char* cloudstorage_sharefile_getaccountsubdomain(void* lpObj);
int cloudstorage_sharefile_setaccountsubdomain(void* lpObj, const char* lpszAccountSubdomain);

QString GetAccountSubdomain();
int SetAccountSubdomain(QString qsAccountSubdomain);

Default Value

""

Remarks

Used for making requests for accounts with subdomains. The domain is typically the account name which can be found in the admin account summary or in the URL.

For example, in https://example.sharefile.com/dashboard, 'example' represents the subdomain.

Data Type

String

Authorization Property (ShareFile Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudstorage_sharefile_getauthorization(void* lpObj);
int cloudstorage_sharefile_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties, using the OAuth class or a separate process. If using the OAuth* properties, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

Data Type

String

CreateLinkOptionsAccessLevel Property (ShareFile Class)

The access level for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsAccessLevel();
int SetCreateLinkOptionsAccessLevel(int iCreateLinkOptionsAccessLevel);

Unicode (Windows)
INT GetCreateLinkOptionsAccessLevel();
INT SetCreateLinkOptionsAccessLevel(INT iCreateLinkOptionsAccessLevel);

SFLAL_ANONYMOUS(0), 
SFLAL_USER_INFO(1), 
SFLAL_EMPLOYEES_AND_CLIENTS(2), 
SFLAL_EMPLOYEES_ONLY(3)

int cloudstorage_sharefile_getcreatelinkoptionsaccesslevel(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsaccesslevel(void* lpObj, int iCreateLinkOptionsAccessLevel);

int GetCreateLinkOptionsAccessLevel();
int SetCreateLinkOptionsAccessLevel(int iCreateLinkOptionsAccessLevel);

Default Value

0

Remarks

The access level for the link.

This property reflects the link's access level. Possible values are:

• 0 (sflalAnonymous)
• 1 (sflalUserInfo)*
• 2 (sflalEmployeesAndClients)
• 3 (sflalEmployeesOnly)

This property is not available at design time.

Data Type

Integer

CreateLinkOptionsCreationDate Property (ShareFile Class)

The date the link was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreateLinkOptionsCreationDate();

Unicode (Windows)
LPWSTR GetCreateLinkOptionsCreationDate();

char* cloudstorage_sharefile_getcreatelinkoptionscreationdate(void* lpObj);

QString GetCreateLinkOptionsCreationDate();

Default Value

""

Remarks

The date the link was created.

This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time.

This property is read-only and not available at design time.

Data Type

String

CreateLinkOptionsExpirationDate Property (ShareFile Class)

The expiration date for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreateLinkOptionsExpirationDate();
int SetCreateLinkOptionsExpirationDate(const char* lpszCreateLinkOptionsExpirationDate);

Unicode (Windows)
LPWSTR GetCreateLinkOptionsExpirationDate();
INT SetCreateLinkOptionsExpirationDate(LPCWSTR lpszCreateLinkOptionsExpirationDate);

char* cloudstorage_sharefile_getcreatelinkoptionsexpirationdate(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsexpirationdate(void* lpObj, const char* lpszCreateLinkOptionsExpirationDate);

QString GetCreateLinkOptionsExpirationDate();
int SetCreateLinkOptionsExpirationDate(QString qsCreateLinkOptionsExpirationDate);

Default Value

""

Remarks

The expiration date for the link.

This property specifies the expiration date for when the link will no longer be valid. To modify this property see UpdateLink.

This property is not available at design time.

Data Type

String

CreateLinkOptionsId Property (ShareFile Class)

The id of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreateLinkOptionsId();

Unicode (Windows)
LPWSTR GetCreateLinkOptionsId();

char* cloudstorage_sharefile_getcreatelinkoptionsid(void* lpObj);

QString GetCreateLinkOptionsId();

Default Value

""

Remarks

The id of the link.

This property specifies the id of the link.

This property is read-only and not available at design time.

Data Type

String

CreateLinkOptionsIsViewOnly Property (ShareFile Class)

If the share items can only be viewed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsIsViewOnly();
int SetCreateLinkOptionsIsViewOnly(int bCreateLinkOptionsIsViewOnly);

Unicode (Windows)
BOOL GetCreateLinkOptionsIsViewOnly();
INT SetCreateLinkOptionsIsViewOnly(BOOL bCreateLinkOptionsIsViewOnly);

int cloudstorage_sharefile_getcreatelinkoptionsisviewonly(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsisviewonly(void* lpObj, int bCreateLinkOptionsIsViewOnly);

bool GetCreateLinkOptionsIsViewOnly();
int SetCreateLinkOptionsIsViewOnly(bool bCreateLinkOptionsIsViewOnly);

Default Value

FALSE

Remarks

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

This property is not available at design time.

Data Type

Boolean

CreateLinkOptionsMaxDownloads Property (ShareFile Class)

The maximum downloads for a link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsMaxDownloads();
int SetCreateLinkOptionsMaxDownloads(int iCreateLinkOptionsMaxDownloads);

Unicode (Windows)
INT GetCreateLinkOptionsMaxDownloads();
INT SetCreateLinkOptionsMaxDownloads(INT iCreateLinkOptionsMaxDownloads);

int cloudstorage_sharefile_getcreatelinkoptionsmaxdownloads(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsmaxdownloads(void* lpObj, int iCreateLinkOptionsMaxDownloads);

int GetCreateLinkOptionsMaxDownloads();
int SetCreateLinkOptionsMaxDownloads(int iCreateLinkOptionsMaxDownloads);

Default Value

-1

Remarks

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see UpdateLink.

This property is not available at design time.

Data Type

Integer

CreateLinkOptionsNotifyOnAccess Property (ShareFile Class)

If the creator is notified when a user accesses the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsNotifyOnAccess();
int SetCreateLinkOptionsNotifyOnAccess(int bCreateLinkOptionsNotifyOnAccess);

Unicode (Windows)
BOOL GetCreateLinkOptionsNotifyOnAccess();
INT SetCreateLinkOptionsNotifyOnAccess(BOOL bCreateLinkOptionsNotifyOnAccess);

int cloudstorage_sharefile_getcreatelinkoptionsnotifyonaccess(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsnotifyonaccess(void* lpObj, int bCreateLinkOptionsNotifyOnAccess);

bool GetCreateLinkOptionsNotifyOnAccess();
int SetCreateLinkOptionsNotifyOnAccess(bool bCreateLinkOptionsNotifyOnAccess);

Default Value

FALSE

Remarks

If the creator is notified when a user accesses the link.

This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to GetLinkInfo or ListLinks.

This property is not available at design time.

Data Type

Boolean

CreateLinkOptionsTitle Property (ShareFile Class)

The title of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreateLinkOptionsTitle();
int SetCreateLinkOptionsTitle(const char* lpszCreateLinkOptionsTitle);

Unicode (Windows)
LPWSTR GetCreateLinkOptionsTitle();
INT SetCreateLinkOptionsTitle(LPCWSTR lpszCreateLinkOptionsTitle);

char* cloudstorage_sharefile_getcreatelinkoptionstitle(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionstitle(void* lpObj, const char* lpszCreateLinkOptionsTitle);

QString GetCreateLinkOptionsTitle();
int SetCreateLinkOptionsTitle(QString qsCreateLinkOptionsTitle);

Default Value

""

Remarks

The title of the link.

This property specifies the title of the link. To modify this property see UpdateItemInfo.

This property is not available at design time.

Data Type

String

CreateLinkOptionsTotalDownloads Property (ShareFile Class)

Total number of times the link has been downloaded from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsTotalDownloads();

Unicode (Windows)
INT GetCreateLinkOptionsTotalDownloads();

int cloudstorage_sharefile_getcreatelinkoptionstotaldownloads(void* lpObj);

int GetCreateLinkOptionsTotalDownloads();

Default Value

0

Remarks

Total number of times the link has been downloaded from.

This property specifies the number of times an item has been downloaded from it.

This property is read-only and not available at design time.

Data Type

Integer

CreateLinkOptionsType Property (ShareFile Class)

The link's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateLinkOptionsType();

Unicode (Windows)
INT GetCreateLinkOptionsType();

SFLT_SEND(0), 
SFLT_REQUEST(1)

int cloudstorage_sharefile_getcreatelinkoptionstype(void* lpObj);

int GetCreateLinkOptionsType();

Default Value

0

Remarks

The link's type.

This property reflects the link's type. Possible values are:

• 0 (sfltSend)
• 1 (sfltRequest)

This property is read-only and not available at design time.

Data Type

Integer

CreateLinkOptionsURL Property (ShareFile Class)

The url for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreateLinkOptionsURL();

Unicode (Windows)
LPWSTR GetCreateLinkOptionsURL();

char* cloudstorage_sharefile_getcreatelinkoptionsurl(void* lpObj);

QString GetCreateLinkOptionsURL();

Default Value

""

Remarks

The url for the link.

This property specifies the url for the link.

This property is read-only and not available at design time.

Data Type

String

CreatePermissionOptionsCanDelete Property (ShareFile Class)

If the user can delete the item or from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsCanDelete();
int SetCreatePermissionOptionsCanDelete(int bCreatePermissionOptionsCanDelete);

Unicode (Windows)
BOOL GetCreatePermissionOptionsCanDelete();
INT SetCreatePermissionOptionsCanDelete(BOOL bCreatePermissionOptionsCanDelete);

int cloudstorage_sharefile_getcreatepermissionoptionscandelete(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscandelete(void* lpObj, int bCreatePermissionOptionsCanDelete);

bool GetCreatePermissionOptionsCanDelete();
int SetCreatePermissionOptionsCanDelete(bool bCreatePermissionOptionsCanDelete);

Default Value

FALSE

Remarks

If the user can delete the item or from the item.

This property defines whether the user can remove items from the item. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsCanDownload Property (ShareFile Class)

If the user can read file content or download the item or from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsCanDownload();
int SetCreatePermissionOptionsCanDownload(int bCreatePermissionOptionsCanDownload);

Unicode (Windows)
BOOL GetCreatePermissionOptionsCanDownload();
INT SetCreatePermissionOptionsCanDownload(BOOL bCreatePermissionOptionsCanDownload);

int cloudstorage_sharefile_getcreatepermissionoptionscandownload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscandownload(void* lpObj, int bCreatePermissionOptionsCanDownload);

bool GetCreatePermissionOptionsCanDownload();
int SetCreatePermissionOptionsCanDownload(bool bCreatePermissionOptionsCanDownload);

Default Value

TRUE

Remarks

If the user can read file content or download the item or from the item.

This property defines whether the user can download or read from the item. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsCanManagePermissions Property (ShareFile Class)

If the user can configure Access Controls in the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsCanManagePermissions();
int SetCreatePermissionOptionsCanManagePermissions(int bCreatePermissionOptionsCanManagePermissions);

Unicode (Windows)
BOOL GetCreatePermissionOptionsCanManagePermissions();
INT SetCreatePermissionOptionsCanManagePermissions(BOOL bCreatePermissionOptionsCanManagePermissions);

int cloudstorage_sharefile_getcreatepermissionoptionscanmanagepermissions(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanmanagepermissions(void* lpObj, int bCreatePermissionOptionsCanManagePermissions);

bool GetCreatePermissionOptionsCanManagePermissions();
int SetCreatePermissionOptionsCanManagePermissions(bool bCreatePermissionOptionsCanManagePermissions);

Default Value

FALSE

Remarks

If the user can configure Access Controls in the item.

This property defines whether the user can configure Access Controls for the item. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsCanUpload Property (ShareFile Class)

Whether the user can upload files to the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsCanUpload();
int SetCreatePermissionOptionsCanUpload(int bCreatePermissionOptionsCanUpload);

Unicode (Windows)
BOOL GetCreatePermissionOptionsCanUpload();
INT SetCreatePermissionOptionsCanUpload(BOOL bCreatePermissionOptionsCanUpload);

int cloudstorage_sharefile_getcreatepermissionoptionscanupload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanupload(void* lpObj, int bCreatePermissionOptionsCanUpload);

bool GetCreatePermissionOptionsCanUpload();
int SetCreatePermissionOptionsCanUpload(bool bCreatePermissionOptionsCanUpload);

Default Value

FALSE

Remarks

Whether the user can upload files to the item.

This property defines whether the user can upload files to the item. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsCanView Property (ShareFile Class)

If the user can view items from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsCanView();
int SetCreatePermissionOptionsCanView(int bCreatePermissionOptionsCanView);

Unicode (Windows)
BOOL GetCreatePermissionOptionsCanView();
INT SetCreatePermissionOptionsCanView(BOOL bCreatePermissionOptionsCanView);

int cloudstorage_sharefile_getcreatepermissionoptionscanview(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanview(void* lpObj, int bCreatePermissionOptionsCanView);

bool GetCreatePermissionOptionsCanView();
int SetCreatePermissionOptionsCanView(bool bCreatePermissionOptionsCanView);

Default Value

TRUE

Remarks

If the user can view items from the item.

This property defines whether the user can view items from this item. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsFolderId Property (ShareFile Class)

The item id for the folder whose permissions are being defined.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreatePermissionOptionsFolderId();

Unicode (Windows)
LPWSTR GetCreatePermissionOptionsFolderId();

char* cloudstorage_sharefile_getcreatepermissionoptionsfolderid(void* lpObj);

QString GetCreatePermissionOptionsFolderId();

Default Value

""

Remarks

The item id for the folder whose permissions are being defined.

This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type.

This property is read-only and not available at design time.

Data Type

String

CreatePermissionOptionsIsOwner Property (ShareFile Class)

If the user is the owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsIsOwner();

Unicode (Windows)
BOOL GetCreatePermissionOptionsIsOwner();

int cloudstorage_sharefile_getcreatepermissionoptionsisowner(void* lpObj);

bool GetCreatePermissionOptionsIsOwner();

Default Value

FALSE

Remarks

If the user is the owner.

This property specifies if the user specified by the CreatePermissionOptionsUserId property is the owner of the item specified by the CreatePermissionOptionsFolderId property.

This property is read-only and not available at design time.

Data Type

Boolean

CreatePermissionOptionsNotifyOnDownload Property (ShareFile Class)

If the user is notified when the an item is downloaded from the folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsNotifyOnDownload();
int SetCreatePermissionOptionsNotifyOnDownload(int bCreatePermissionOptionsNotifyOnDownload);

Unicode (Windows)
BOOL GetCreatePermissionOptionsNotifyOnDownload();
INT SetCreatePermissionOptionsNotifyOnDownload(BOOL bCreatePermissionOptionsNotifyOnDownload);

int cloudstorage_sharefile_getcreatepermissionoptionsnotifyondownload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionsnotifyondownload(void* lpObj, int bCreatePermissionOptionsNotifyOnDownload);

bool GetCreatePermissionOptionsNotifyOnDownload();
int SetCreatePermissionOptionsNotifyOnDownload(bool bCreatePermissionOptionsNotifyOnDownload);

Default Value

FALSE

Remarks

If the user is notified when the an item is downloaded from the folder.

This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsNotifyOnUpload Property (ShareFile Class)

If the user is notified when the an item is uploaded to the folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreatePermissionOptionsNotifyOnUpload();
int SetCreatePermissionOptionsNotifyOnUpload(int bCreatePermissionOptionsNotifyOnUpload);

Unicode (Windows)
BOOL GetCreatePermissionOptionsNotifyOnUpload();
INT SetCreatePermissionOptionsNotifyOnUpload(BOOL bCreatePermissionOptionsNotifyOnUpload);

int cloudstorage_sharefile_getcreatepermissionoptionsnotifyonupload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionsnotifyonupload(void* lpObj, int bCreatePermissionOptionsNotifyOnUpload);

bool GetCreatePermissionOptionsNotifyOnUpload();
int SetCreatePermissionOptionsNotifyOnUpload(bool bCreatePermissionOptionsNotifyOnUpload);

Default Value

FALSE

Remarks

If the user is notified when the an item is uploaded to the folder.

This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see UpdatePermission.

This property is not available at design time.

Data Type

Boolean

CreatePermissionOptionsUserId Property (ShareFile Class)

The user's ShareFile id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreatePermissionOptionsUserId();

Unicode (Windows)
LPWSTR GetCreatePermissionOptionsUserId();

char* cloudstorage_sharefile_getcreatepermissionoptionsuserid(void* lpObj);

QString GetCreatePermissionOptionsUserId();

Default Value

""

Remarks

The user's ShareFile id.

This property specifies the user's user id that the permission is for.

This property is read-only and not available at design time.

Data Type

String

EncryptionAlgorithm Property (ShareFile Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

EA_AES(0), 
EA_BLOWFISH(1), 
EA_CAST(2), 
EA_DES(3), 
EA_IDEA(4), 
EA_RC2(5), 
EA_RC4(6), 
EA_TEA(7), 
EA_TRIPLE_DES(8), 
EA_TWOFISH(9), 
EA_RIJNDAEL(10), 
EA_CHA_CHA(11), 
EA_XSALSA_20(12)

int cloudstorage_sharefile_getencryptionalgorithm(void* lpObj);
int cloudstorage_sharefile_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (ShareFile Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* cloudstorage_sharefile_getencryptionpassword(void* lpObj);
int cloudstorage_sharefile_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (ShareFile Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int cloudstorage_sharefile_getfirewallautodetect(void* lpObj);
int cloudstorage_sharefile_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (ShareFile Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int cloudstorage_sharefile_getfirewalltype(void* lpObj);
int cloudstorage_sharefile_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (ShareFile Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* cloudstorage_sharefile_getfirewallhost(void* lpObj);
int cloudstorage_sharefile_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (ShareFile Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* cloudstorage_sharefile_getfirewallpassword(void* lpObj);
int cloudstorage_sharefile_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (ShareFile Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int cloudstorage_sharefile_getfirewallport(void* lpObj);
int cloudstorage_sharefile_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (ShareFile Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* cloudstorage_sharefile_getfirewalluser(void* lpObj);
int cloudstorage_sharefile_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (ShareFile Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_sharefile_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

ItemData Property (ShareFile Class)

The data that was downloaded, or that should be uploaded by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemData(char* &lpItemData, int &lenItemData);
int SetItemData(const char* lpItemData, int lenItemData);

Unicode (Windows)
INT GetItemData(LPSTR &lpItemData, INT &lenItemData);
INT SetItemData(LPCSTR lpItemData, INT lenItemData);

int cloudstorage_sharefile_getitemdata(void* lpObj, char** lpItemData, int* lenItemData);
int cloudstorage_sharefile_setitemdata(void* lpObj, const char* lpItemData, int lenItemData);

QByteArray GetItemData();
int SetItemData(QByteArray qbaItemData);

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile if SetDownloadStream and LocalFile are not set.

This property can also be set before calling UploadFile; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

ItemCount Property (ShareFile Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemCount();
int SetItemCount(int iItemCount);

Unicode (Windows)
INT GetItemCount();
INT SetItemCount(INT iItemCount);

int cloudstorage_sharefile_getitemcount(void* lpObj);
int cloudstorage_sharefile_setitemcount(void* lpObj, int iItemCount);

int GetItemCount();
int SetItemCount(int iItemCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemCreationDate
• ItemCreatorFirstName
• ItemCreatorLastName
• ItemDescription
• ItemExpirationDate
• ItemId
• ItemName
• ItemParentId
• ItemPath
• ItemSize
• ItemType

The array indices start at 0 and end at ItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemCreationDate Property (ShareFile Class)

The date when the item was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCreationDate(int iItemIndex);

Unicode (Windows)
LPWSTR GetItemCreationDate(INT iItemIndex);

char* cloudstorage_sharefile_getitemcreationdate(void* lpObj, int itemindex);

QString GetItemCreationDate(int iItemIndex);

Default Value

""

Remarks

The date when the item was created.

This property specifies the creation date of the item. Dates are formatted according to ISO 8601 and are always in UTC time.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

String

ItemCreatorFirstName Property (ShareFile Class)

The first name of the creator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCreatorFirstName(int iItemIndex);

Unicode (Windows)
LPWSTR GetItemCreatorFirstName(INT iItemIndex);

char* cloudstorage_sharefile_getitemcreatorfirstname(void* lpObj, int itemindex);

QString GetItemCreatorFirstName(int iItemIndex);

Default Value

""

Remarks

The first name of the creator.

This property specifies first name of the creator.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

String

ItemCreatorLastName Property (ShareFile Class)

The last name of the creator.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCreatorLastName(int iItemIndex);

Unicode (Windows)
LPWSTR GetItemCreatorLastName(INT iItemIndex);

char* cloudstorage_sharefile_getitemcreatorlastname(void* lpObj, int itemindex);

QString GetItemCreatorLastName(int iItemIndex);

Default Value

""

Remarks

The last name of the creator.

This property specifies last name of the creator.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

String

ItemDescription Property (ShareFile Class)

The description of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, const char* lpszItemDescription);

Unicode (Windows)
LPWSTR GetItemDescription(INT iItemIndex);
INT SetItemDescription(INT iItemIndex, LPCWSTR lpszItemDescription);

char* cloudstorage_sharefile_getitemdescription(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

Default Value

""

Remarks

The description of the item.

This property specifies the description of the item. To modify this property see UpdateItemInfo.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemExpirationDate Property (ShareFile Class)

The expiration date for the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemExpirationDate(int iItemIndex);
int SetItemExpirationDate(int iItemIndex, const char* lpszItemExpirationDate);

Unicode (Windows)
LPWSTR GetItemExpirationDate(INT iItemIndex);
INT SetItemExpirationDate(INT iItemIndex, LPCWSTR lpszItemExpirationDate);

char* cloudstorage_sharefile_getitemexpirationdate(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemexpirationdate(void* lpObj, int itemindex, const char* lpszItemExpirationDate);

QString GetItemExpirationDate(int iItemIndex);
int SetItemExpirationDate(int iItemIndex, QString qsItemExpirationDate);

Default Value

""

Remarks

The expiration date for the item.

This property specifies the expiration date for the item. After the date ShareFile will move the item into the recycle bin. To modify this property see UpdateItemInfo.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemId Property (ShareFile Class)

The id of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemId(int iItemIndex);

Unicode (Windows)
LPWSTR GetItemId(INT iItemIndex);

char* cloudstorage_sharefile_getitemid(void* lpObj, int itemindex);

QString GetItemId(int iItemIndex);

Default Value

""

Remarks

The id of the item.

This property specifies the id for the item.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

String

ItemName Property (ShareFile Class)

The name of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, const char* lpszItemName);

Unicode (Windows)
LPWSTR GetItemName(INT iItemIndex);
INT SetItemName(INT iItemIndex, LPCWSTR lpszItemName);

char* cloudstorage_sharefile_getitemname(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

Default Value

""

Remarks

The name of the item.

This property specifies the name of the item. For example, a files name might be example.txt while a folder might be exampleFolder. To modify this field see UpdateItemInfo.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemParentId Property (ShareFile Class)

The id of the parent item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemParentId(int iItemIndex);
int SetItemParentId(int iItemIndex, const char* lpszItemParentId);

Unicode (Windows)
LPWSTR GetItemParentId(INT iItemIndex);
INT SetItemParentId(INT iItemIndex, LPCWSTR lpszItemParentId);

char* cloudstorage_sharefile_getitemparentid(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemparentid(void* lpObj, int itemindex, const char* lpszItemParentId);

QString GetItemParentId(int iItemIndex);
int SetItemParentId(int iItemIndex, QString qsItemParentId);

Default Value

""

Remarks

The id of the parent item.

This property specifies the id of the parent item. For example, if the current item is a file in the exampleFolder folder then the ParentId will be the id of the exampleFolder item. To modify this property see UpdateItemInfo.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemPath Property (ShareFile Class)

The path to the parent folder for an item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemPath(int iItemIndex);
int SetItemPath(int iItemIndex, const char* lpszItemPath);

Unicode (Windows)
LPWSTR GetItemPath(INT iItemIndex);
INT SetItemPath(INT iItemIndex, LPCWSTR lpszItemPath);

char* cloudstorage_sharefile_getitempath(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitempath(void* lpObj, int itemindex, const char* lpszItemPath);

QString GetItemPath(int iItemIndex);
int SetItemPath(int iItemIndex, QString qsItemPath);

Default Value

""

Remarks

The path to the parent folder for an item.

The property specifies the path from the virtual root to the parent folder for an item. This path is determined by ShareFile.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemSize Property (ShareFile Class)

The size of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetItemSize(int iItemIndex);

Unicode (Windows)
LONG64 GetItemSize(INT iItemIndex);

int64 cloudstorage_sharefile_getitemsize(void* lpObj, int itemindex);

qint64 GetItemSize(int iItemIndex);

Default Value

0

Remarks

The size of the item.

The property specifies the size of the item. If the item is a file then the size will be in KB and contain the size of the file. If the item is a folder then it will be the size of the children items, recursively.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

Long64

ItemType Property (ShareFile Class)

The item's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemType(int iItemIndex);

Unicode (Windows)
INT GetItemType(INT iItemIndex);

SFIT_FILE(0), 
SFIT_FOLDER(1), 
SFIT_LINK(2), 
SFIT_NOTE(3), 
SFIT_SYMBOLIC_LINK(4)

int cloudstorage_sharefile_getitemtype(void* lpObj, int itemindex);

int GetItemType(int iItemIndex);

Default Value

0

Remarks

The item's type.

This property reflects the item's type. Possible values are:

• 0 (sfitFile)
• 1 (sfitFolder)
• 2 (sfitLink)*
• 3 (sfitNote)
• 4 (sfitSymbolicLink)*

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is read-only and not available at design time.

Data Type

Integer

LinkCount Property (ShareFile Class)

The number of records in the Link arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkCount();
int SetLinkCount(int iLinkCount);

Unicode (Windows)
INT GetLinkCount();
INT SetLinkCount(INT iLinkCount);

int cloudstorage_sharefile_getlinkcount(void* lpObj);
int cloudstorage_sharefile_setlinkcount(void* lpObj, int iLinkCount);

int GetLinkCount();
int SetLinkCount(int iLinkCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• LinkAccessLevel
• LinkCreationDate
• LinkExpirationDate
• LinkId
• LinkIsViewOnly
• LinkMaxDownloads
• LinkNotifyOnAccess
• LinkTitle
• LinkTotalDownloads
• LinkType
• LinkURL

The array indices start at 0 and end at LinkCount - 1.

This property is not available at design time.

Data Type

Integer

LinkAccessLevel Property (ShareFile Class)

The access level for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkAccessLevel(int iLinkIndex);
int SetLinkAccessLevel(int iLinkIndex, int iLinkAccessLevel);

Unicode (Windows)
INT GetLinkAccessLevel(INT iLinkIndex);
INT SetLinkAccessLevel(INT iLinkIndex, INT iLinkAccessLevel);

SFLAL_ANONYMOUS(0), 
SFLAL_USER_INFO(1), 
SFLAL_EMPLOYEES_AND_CLIENTS(2), 
SFLAL_EMPLOYEES_ONLY(3)

int cloudstorage_sharefile_getlinkaccesslevel(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkaccesslevel(void* lpObj, int linkindex, int iLinkAccessLevel);

int GetLinkAccessLevel(int iLinkIndex);
int SetLinkAccessLevel(int iLinkIndex, int iLinkAccessLevel);

Default Value

0

Remarks

The access level for the link.

This property reflects the link's access level. Possible values are:

• 0 (sflalAnonymous)
• 1 (sflalUserInfo)*
• 2 (sflalEmployeesAndClients)
• 3 (sflalEmployeesOnly)

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Integer

LinkCreationDate Property (ShareFile Class)

The date the link was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkCreationDate(int iLinkIndex);

Unicode (Windows)
LPWSTR GetLinkCreationDate(INT iLinkIndex);

char* cloudstorage_sharefile_getlinkcreationdate(void* lpObj, int linkindex);

QString GetLinkCreationDate(int iLinkIndex);

Default Value

""

Remarks

The date the link was created.

This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

String

LinkExpirationDate Property (ShareFile Class)

The expiration date for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkExpirationDate(int iLinkIndex);
int SetLinkExpirationDate(int iLinkIndex, const char* lpszLinkExpirationDate);

Unicode (Windows)
LPWSTR GetLinkExpirationDate(INT iLinkIndex);
INT SetLinkExpirationDate(INT iLinkIndex, LPCWSTR lpszLinkExpirationDate);

char* cloudstorage_sharefile_getlinkexpirationdate(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkexpirationdate(void* lpObj, int linkindex, const char* lpszLinkExpirationDate);

QString GetLinkExpirationDate(int iLinkIndex);
int SetLinkExpirationDate(int iLinkIndex, QString qsLinkExpirationDate);

Default Value

""

Remarks

The expiration date for the link.

This property specifies the expiration date for when the link will no longer be valid. To modify this property see UpdateLink.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

String

LinkId Property (ShareFile Class)

The id of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkId(int iLinkIndex);

Unicode (Windows)
LPWSTR GetLinkId(INT iLinkIndex);

char* cloudstorage_sharefile_getlinkid(void* lpObj, int linkindex);

QString GetLinkId(int iLinkIndex);

Default Value

""

Remarks

The id of the link.

This property specifies the id of the link.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

String

LinkIsViewOnly Property (ShareFile Class)

If the share items can only be viewed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkIsViewOnly(int iLinkIndex);
int SetLinkIsViewOnly(int iLinkIndex, int bLinkIsViewOnly);

Unicode (Windows)
BOOL GetLinkIsViewOnly(INT iLinkIndex);
INT SetLinkIsViewOnly(INT iLinkIndex, BOOL bLinkIsViewOnly);

int cloudstorage_sharefile_getlinkisviewonly(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkisviewonly(void* lpObj, int linkindex, int bLinkIsViewOnly);

bool GetLinkIsViewOnly(int iLinkIndex);
int SetLinkIsViewOnly(int iLinkIndex, bool bLinkIsViewOnly);

Default Value

FALSE

Remarks

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Boolean

LinkMaxDownloads Property (ShareFile Class)

The maximum downloads for a link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkMaxDownloads(int iLinkIndex);
int SetLinkMaxDownloads(int iLinkIndex, int iLinkMaxDownloads);

Unicode (Windows)
INT GetLinkMaxDownloads(INT iLinkIndex);
INT SetLinkMaxDownloads(INT iLinkIndex, INT iLinkMaxDownloads);

int cloudstorage_sharefile_getlinkmaxdownloads(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkmaxdownloads(void* lpObj, int linkindex, int iLinkMaxDownloads);

int GetLinkMaxDownloads(int iLinkIndex);
int SetLinkMaxDownloads(int iLinkIndex, int iLinkMaxDownloads);

Default Value

-1

Remarks

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see UpdateLink.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Integer

LinkNotifyOnAccess Property (ShareFile Class)

If the creator is notified when a user accesses the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkNotifyOnAccess(int iLinkIndex);
int SetLinkNotifyOnAccess(int iLinkIndex, int bLinkNotifyOnAccess);

Unicode (Windows)
BOOL GetLinkNotifyOnAccess(INT iLinkIndex);
INT SetLinkNotifyOnAccess(INT iLinkIndex, BOOL bLinkNotifyOnAccess);

int cloudstorage_sharefile_getlinknotifyonaccess(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinknotifyonaccess(void* lpObj, int linkindex, int bLinkNotifyOnAccess);

bool GetLinkNotifyOnAccess(int iLinkIndex);
int SetLinkNotifyOnAccess(int iLinkIndex, bool bLinkNotifyOnAccess);

Default Value

FALSE

Remarks

If the creator is notified when a user accesses the link.

This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to GetLinkInfo or ListLinks.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Boolean

LinkTitle Property (ShareFile Class)

The title of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkTitle(int iLinkIndex);
int SetLinkTitle(int iLinkIndex, const char* lpszLinkTitle);

Unicode (Windows)
LPWSTR GetLinkTitle(INT iLinkIndex);
INT SetLinkTitle(INT iLinkIndex, LPCWSTR lpszLinkTitle);

char* cloudstorage_sharefile_getlinktitle(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinktitle(void* lpObj, int linkindex, const char* lpszLinkTitle);

QString GetLinkTitle(int iLinkIndex);
int SetLinkTitle(int iLinkIndex, QString qsLinkTitle);

Default Value

""

Remarks

The title of the link.

This property specifies the title of the link. To modify this property see UpdateItemInfo.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

String

LinkTotalDownloads Property (ShareFile Class)

Total number of times the link has been downloaded from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkTotalDownloads(int iLinkIndex);

Unicode (Windows)
INT GetLinkTotalDownloads(INT iLinkIndex);

int cloudstorage_sharefile_getlinktotaldownloads(void* lpObj, int linkindex);

int GetLinkTotalDownloads(int iLinkIndex);

Default Value

0

Remarks

Total number of times the link has been downloaded from.

This property specifies the number of times an item has been downloaded from it.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

Integer

LinkType Property (ShareFile Class)

The link's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkType(int iLinkIndex);

Unicode (Windows)
INT GetLinkType(INT iLinkIndex);

SFLT_SEND(0), 
SFLT_REQUEST(1)

int cloudstorage_sharefile_getlinktype(void* lpObj, int linkindex);

int GetLinkType(int iLinkIndex);

Default Value

0

Remarks

The link's type.

This property reflects the link's type. Possible values are:

• 0 (sfltSend)
• 1 (sfltRequest)

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

Integer

LinkURL Property (ShareFile Class)

The url for the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkURL(int iLinkIndex);

Unicode (Windows)
LPWSTR GetLinkURL(INT iLinkIndex);

char* cloudstorage_sharefile_getlinkurl(void* lpObj, int linkindex);

QString GetLinkURL(int iLinkIndex);

Default Value

""

Remarks

The url for the link.

This property specifies the url for the link.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only and not available at design time.

Data Type

String

LocalFile Property (ShareFile Class)

The location of the local file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudstorage_sharefile_getlocalfile(void* lpObj);
wchar_t* cloudstorage_sharefile_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_sharefile_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_sharefile_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile and as the destination file when calling DownloadFile.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

Data Type

String

LocalHost Property (ShareFile Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudstorage_sharefile_getlocalhost(void* lpObj);
int cloudstorage_sharefile_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OAuthAccessToken Property (ShareFile Class)

The access token returned by the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAccessToken();
int SetOAuthAccessToken(const char* lpszOAuthAccessToken);

Unicode (Windows)
LPWSTR GetOAuthAccessToken();
INT SetOAuthAccessToken(LPCWSTR lpszOAuthAccessToken);

char* cloudstorage_sharefile_getoauthaccesstoken(void* lpObj);
int cloudstorage_sharefile_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (ShareFile Class)

The authorization code that is exchanged for an access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(const char* lpszOAuthAuthorizationCode);

Unicode (Windows)
LPWSTR GetOAuthAuthorizationCode();
INT SetOAuthAuthorizationCode(LPCWSTR lpszOAuthAuthorizationCode);

char* cloudstorage_sharefile_getoauthauthorizationcode(void* lpObj);
int cloudstorage_sharefile_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (ShareFile Class)

The scope request or response parameter used during authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(const char* lpszOAuthAuthorizationScope);

Unicode (Windows)
LPWSTR GetOAuthAuthorizationScope();
INT SetOAuthAuthorizationScope(LPCWSTR lpszOAuthAuthorizationScope);

char* cloudstorage_sharefile_getoauthauthorizationscope(void* lpObj);
int cloudstorage_sharefile_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (ShareFile Class)

The id of the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthClientId();
int SetOAuthClientId(const char* lpszOAuthClientId);

Unicode (Windows)
LPWSTR GetOAuthClientId();
INT SetOAuthClientId(LPCWSTR lpszOAuthClientId);

char* cloudstorage_sharefile_getoauthclientid(void* lpObj);
int cloudstorage_sharefile_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (ShareFile Class)

The type of client that is requesting authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

Unicode (Windows)
INT GetOAuthClientProfile();
INT SetOAuthClientProfile(INT iOAuthClientProfile);

COCP_APPLICATION(0), 
COCP_WEB(1)

int cloudstorage_sharefile_getoauthclientprofile(void* lpObj);
int cloudstorage_sharefile_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (ShareFile Class)

The secret value for the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthClientSecret();
int SetOAuthClientSecret(const char* lpszOAuthClientSecret);

Unicode (Windows)
LPWSTR GetOAuthClientSecret();
INT SetOAuthClientSecret(LPCWSTR lpszOAuthClientSecret);

char* cloudstorage_sharefile_getoauthclientsecret(void* lpObj);
int cloudstorage_sharefile_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (ShareFile Class)

The OAuth grant type used to acquire an OAuth access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

Unicode (Windows)
INT GetOAuthGrantType();
INT SetOAuthGrantType(INT iOAuthGrantType);

COGT_AUTHORIZATION_CODE(0), 
COGT_IMPLICIT(1), 
COGT_PASSWORD(2), 
COGT_CLIENT_CREDENTIALS(3)

int cloudstorage_sharefile_getoauthgranttype(void* lpObj);
int cloudstorage_sharefile_setoauthgranttype(void* lpObj, int iOAuthGrantType);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (ShareFile Class)

Specifies the refresh token received from or sent to the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthRefreshToken();
int SetOAuthRefreshToken(const char* lpszOAuthRefreshToken);

Unicode (Windows)
LPWSTR GetOAuthRefreshToken();
INT SetOAuthRefreshToken(LPCWSTR lpszOAuthRefreshToken);

char* cloudstorage_sharefile_getoauthrefreshtoken(void* lpObj);
int cloudstorage_sharefile_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (ShareFile Class)

The URL where the user (browser) returns after authenticating.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthReturnURL();
int SetOAuthReturnURL(const char* lpszOAuthReturnURL);

Unicode (Windows)
LPWSTR GetOAuthReturnURL();
INT SetOAuthReturnURL(LPCWSTR lpszOAuthReturnURL);

char* cloudstorage_sharefile_getoauthreturnurl(void* lpObj);
int cloudstorage_sharefile_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (ShareFile Class)

The URL of the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(const char* lpszOAuthServerAuthURL);

Unicode (Windows)
LPWSTR GetOAuthServerAuthURL();
INT SetOAuthServerAuthURL(LPCWSTR lpszOAuthServerAuthURL);

char* cloudstorage_sharefile_getoauthserverauthurl(void* lpObj);
int cloudstorage_sharefile_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (ShareFile Class)

The URL of the token server used to obtain the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(const char* lpszOAuthServerTokenURL);

Unicode (Windows)
LPWSTR GetOAuthServerTokenURL();
INT SetOAuthServerTokenURL(LPCWSTR lpszOAuthServerTokenURL);

char* cloudstorage_sharefile_getoauthservertokenurl(void* lpObj);
int cloudstorage_sharefile_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (ShareFile Class)

The URL to which the user should be re-directed for authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOAuthWebAuthURL();

Unicode (Windows)
LPWSTR GetOAuthWebAuthURL();

char* cloudstorage_sharefile_getoauthwebauthurl(void* lpObj);

QString GetOAuthWebAuthURL();

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (ShareFile Class)

This property includes other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudstorage_sharefile_getotherheaders(void* lpObj);
int cloudstorage_sharefile_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (ShareFile Class)

Whether to overwrite the local or remote file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudstorage_sharefile_getoverwrite(void* lpObj);
int cloudstorage_sharefile_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be if it already exists.

Note: This setting is not currently respected by the ShareFile service for file uploads. If the file has file versioning turned on it will retain the previous version. If the file versioning is turned off, the file will always be overwritten.

Data Type

Boolean

ParsedHeaderCount Property (ShareFile Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudstorage_sharefile_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (ShareFile Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* cloudstorage_sharefile_getparsedheaderfield(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (ShareFile Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

char* cloudstorage_sharefile_getparsedheadervalue(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

PermissionCount Property (ShareFile Class)

The number of records in the Permission arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCount();
int SetPermissionCount(int iPermissionCount);

Unicode (Windows)
INT GetPermissionCount();
INT SetPermissionCount(INT iPermissionCount);

int cloudstorage_sharefile_getpermissioncount(void* lpObj);
int cloudstorage_sharefile_setpermissioncount(void* lpObj, int iPermissionCount);

int GetPermissionCount();
int SetPermissionCount(int iPermissionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• PermissionCanDelete
• PermissionCanDownload
• PermissionCanManagePermissions
• PermissionCanUpload
• PermissionCanView
• PermissionFolderId
• PermissionIsOwner
• PermissionNotifyOnDownload
• PermissionNotifyOnUpload
• PermissionUserId

The array indices start at 0 and end at PermissionCount - 1.

This property is not available at design time.

Data Type

Integer

PermissionCanDelete Property (ShareFile Class)

If the user can delete the item or from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCanDelete(int iPermissionIndex);
int SetPermissionCanDelete(int iPermissionIndex, int bPermissionCanDelete);

Unicode (Windows)
BOOL GetPermissionCanDelete(INT iPermissionIndex);
INT SetPermissionCanDelete(INT iPermissionIndex, BOOL bPermissionCanDelete);

int cloudstorage_sharefile_getpermissioncandelete(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncandelete(void* lpObj, int permissionindex, int bPermissionCanDelete);

bool GetPermissionCanDelete(int iPermissionIndex);
int SetPermissionCanDelete(int iPermissionIndex, bool bPermissionCanDelete);

Default Value

FALSE

Remarks

If the user can delete the item or from the item.

This property defines whether the user can remove items from the item. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionCanDownload Property (ShareFile Class)

If the user can read file content or download the item or from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCanDownload(int iPermissionIndex);
int SetPermissionCanDownload(int iPermissionIndex, int bPermissionCanDownload);

Unicode (Windows)
BOOL GetPermissionCanDownload(INT iPermissionIndex);
INT SetPermissionCanDownload(INT iPermissionIndex, BOOL bPermissionCanDownload);

int cloudstorage_sharefile_getpermissioncandownload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncandownload(void* lpObj, int permissionindex, int bPermissionCanDownload);

bool GetPermissionCanDownload(int iPermissionIndex);
int SetPermissionCanDownload(int iPermissionIndex, bool bPermissionCanDownload);

Default Value

TRUE

Remarks

If the user can read file content or download the item or from the item.

This property defines whether the user can download or read from the item. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionCanManagePermissions Property (ShareFile Class)

If the user can configure Access Controls in the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCanManagePermissions(int iPermissionIndex);
int SetPermissionCanManagePermissions(int iPermissionIndex, int bPermissionCanManagePermissions);

Unicode (Windows)
BOOL GetPermissionCanManagePermissions(INT iPermissionIndex);
INT SetPermissionCanManagePermissions(INT iPermissionIndex, BOOL bPermissionCanManagePermissions);

int cloudstorage_sharefile_getpermissioncanmanagepermissions(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanmanagepermissions(void* lpObj, int permissionindex, int bPermissionCanManagePermissions);

bool GetPermissionCanManagePermissions(int iPermissionIndex);
int SetPermissionCanManagePermissions(int iPermissionIndex, bool bPermissionCanManagePermissions);

Default Value

FALSE

Remarks

If the user can configure Access Controls in the item.

This property defines whether the user can configure Access Controls for the item. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionCanUpload Property (ShareFile Class)

Whether the user can upload files to the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCanUpload(int iPermissionIndex);
int SetPermissionCanUpload(int iPermissionIndex, int bPermissionCanUpload);

Unicode (Windows)
BOOL GetPermissionCanUpload(INT iPermissionIndex);
INT SetPermissionCanUpload(INT iPermissionIndex, BOOL bPermissionCanUpload);

int cloudstorage_sharefile_getpermissioncanupload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanupload(void* lpObj, int permissionindex, int bPermissionCanUpload);

bool GetPermissionCanUpload(int iPermissionIndex);
int SetPermissionCanUpload(int iPermissionIndex, bool bPermissionCanUpload);

Default Value

FALSE

Remarks

Whether the user can upload files to the item.

This property defines whether the user can upload files to the item. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionCanView Property (ShareFile Class)

If the user can view items from the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionCanView(int iPermissionIndex);
int SetPermissionCanView(int iPermissionIndex, int bPermissionCanView);

Unicode (Windows)
BOOL GetPermissionCanView(INT iPermissionIndex);
INT SetPermissionCanView(INT iPermissionIndex, BOOL bPermissionCanView);

int cloudstorage_sharefile_getpermissioncanview(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanview(void* lpObj, int permissionindex, int bPermissionCanView);

bool GetPermissionCanView(int iPermissionIndex);
int SetPermissionCanView(int iPermissionIndex, bool bPermissionCanView);

Default Value

TRUE

Remarks

If the user can view items from the item.

This property defines whether the user can view items from this item. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionFolderId Property (ShareFile Class)

The item id for the folder whose permissions are being defined.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermissionFolderId(int iPermissionIndex);

Unicode (Windows)
LPWSTR GetPermissionFolderId(INT iPermissionIndex);

char* cloudstorage_sharefile_getpermissionfolderid(void* lpObj, int permissionindex);

QString GetPermissionFolderId(int iPermissionIndex);

Default Value

""

Remarks

The item id for the folder whose permissions are being defined.

This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is read-only and not available at design time.

Data Type

String

PermissionIsOwner Property (ShareFile Class)

If the user is the owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionIsOwner(int iPermissionIndex);

Unicode (Windows)
BOOL GetPermissionIsOwner(INT iPermissionIndex);

int cloudstorage_sharefile_getpermissionisowner(void* lpObj, int permissionindex);

bool GetPermissionIsOwner(int iPermissionIndex);

Default Value

FALSE

Remarks

If the user is the owner.

This property specifies if the user specified by the PermissionUserId property is the owner of the item specified by the PermissionFolderId property.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

PermissionNotifyOnDownload Property (ShareFile Class)

If the user is notified when the an item is downloaded from the folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionNotifyOnDownload(int iPermissionIndex);
int SetPermissionNotifyOnDownload(int iPermissionIndex, int bPermissionNotifyOnDownload);

Unicode (Windows)
BOOL GetPermissionNotifyOnDownload(INT iPermissionIndex);
INT SetPermissionNotifyOnDownload(INT iPermissionIndex, BOOL bPermissionNotifyOnDownload);

int cloudstorage_sharefile_getpermissionnotifyondownload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissionnotifyondownload(void* lpObj, int permissionindex, int bPermissionNotifyOnDownload);

bool GetPermissionNotifyOnDownload(int iPermissionIndex);
int SetPermissionNotifyOnDownload(int iPermissionIndex, bool bPermissionNotifyOnDownload);

Default Value

FALSE

Remarks

If the user is notified when the an item is downloaded from the folder.

This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionNotifyOnUpload Property (ShareFile Class)

If the user is notified when the an item is uploaded to the folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionNotifyOnUpload(int iPermissionIndex);
int SetPermissionNotifyOnUpload(int iPermissionIndex, int bPermissionNotifyOnUpload);

Unicode (Windows)
BOOL GetPermissionNotifyOnUpload(INT iPermissionIndex);
INT SetPermissionNotifyOnUpload(INT iPermissionIndex, BOOL bPermissionNotifyOnUpload);

int cloudstorage_sharefile_getpermissionnotifyonupload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissionnotifyonupload(void* lpObj, int permissionindex, int bPermissionNotifyOnUpload);

bool GetPermissionNotifyOnUpload(int iPermissionIndex);
int SetPermissionNotifyOnUpload(int iPermissionIndex, bool bPermissionNotifyOnUpload);

Default Value

FALSE

Remarks

If the user is notified when the an item is uploaded to the folder.

This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see UpdatePermission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionUserId Property (ShareFile Class)

The user's ShareFile id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermissionUserId(int iPermissionIndex);

Unicode (Windows)
LPWSTR GetPermissionUserId(INT iPermissionIndex);

char* cloudstorage_sharefile_getpermissionuserid(void* lpObj, int permissionindex);

QString GetPermissionUserId(int iPermissionIndex);

Default Value

""

Remarks

The user's ShareFile id.

This property specifies the user's user id that the permission is for.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (ShareFile Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int cloudstorage_sharefile_getproxyauthscheme(void* lpObj);
int cloudstorage_sharefile_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (ShareFile Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int cloudstorage_sharefile_getproxyautodetect(void* lpObj);
int cloudstorage_sharefile_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (ShareFile Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* cloudstorage_sharefile_getproxypassword(void* lpObj);
int cloudstorage_sharefile_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (ShareFile Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int cloudstorage_sharefile_getproxyport(void* lpObj);
int cloudstorage_sharefile_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (ShareFile Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* cloudstorage_sharefile_getproxyserver(void* lpObj);
int cloudstorage_sharefile_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (ShareFile Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int cloudstorage_sharefile_getproxyssl(void* lpObj);
int cloudstorage_sharefile_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (ShareFile Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* cloudstorage_sharefile_getproxyuser(void* lpObj);
int cloudstorage_sharefile_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (ShareFile Class)

The number of records in the QueryParam arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Unicode (Windows)
INT GetQueryParamCount();
INT SetQueryParamCount(INT iQueryParamCount);

int cloudstorage_sharefile_getqueryparamcount(void* lpObj);
int cloudstorage_sharefile_setqueryparamcount(void* lpObj, int iQueryParamCount);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (ShareFile Class)

The name of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName);

Unicode (Windows)
LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);

char* cloudstorage_sharefile_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_sharefile_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (ShareFile Class)

The value of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue);

Unicode (Windows)
LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);

char* cloudstorage_sharefile_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_sharefile_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

ResumeURL Property (ShareFile Class)

The resumable upload URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResumeURL();
int SetResumeURL(const char* lpszResumeURL);

Unicode (Windows)
LPWSTR GetResumeURL();
INT SetResumeURL(LPCWSTR lpszResumeURL);

char* cloudstorage_sharefile_getresumeurl(void* lpObj);
int cloudstorage_sharefile_setresumeurl(void* lpObj, const char* lpszResumeURL);

QString GetResumeURL();
int SetResumeURL(QString qsResumeURL);

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

SearchMarker Property (ShareFile Class)

A marker indicating the number of search results to skip next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchMarker();
int SetSearchMarker(int iSearchMarker);

Unicode (Windows)
INT GetSearchMarker();
INT SetSearchMarker(INT iSearchMarker);

int cloudstorage_sharefile_getsearchmarker(void* lpObj);
int cloudstorage_sharefile_setsearchmarker(void* lpObj, int iSearchMarker);

int GetSearchMarker();
int SetSearchMarker(int iSearchMarker);

Default Value

0

Remarks

This property will be populated when Search is called if the results are paged and there are more pages. To list all search results, continue to call Search until this property returns 0.

Refer to Search for more information.

Note: Currently, ShareFile does not support the search functionality.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (ShareFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int cloudstorage_sharefile_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_sharefile_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (ShareFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int cloudstorage_sharefile_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_sharefile_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (ShareFile Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int cloudstorage_sharefile_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_sharefile_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (ShareFile Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* cloudstorage_sharefile_getsslcertstorepassword(void* lpObj);
int cloudstorage_sharefile_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (ShareFile Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int cloudstorage_sharefile_getsslcertstoretype(void* lpObj);
int cloudstorage_sharefile_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (ShareFile Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* cloudstorage_sharefile_getsslcertsubject(void* lpObj);
int cloudstorage_sharefile_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (ShareFile Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudstorage_sharefile_getsslprovider(void* lpObj);
int cloudstorage_sharefile_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (ShareFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int cloudstorage_sharefile_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

StartByte Property (ShareFile Class)

The byte offset from which to start the upload or download.

Syntax

• C++
• C
• Qt