ShareFile Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ShareFile

Remarks

The ShareFile control 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 control 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 control. 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 control 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 control 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 control 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 control will use an authorization code to get an access token. For this OAuthGrantType the control 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 control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control 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 control 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 control will request the authorization server to get an access token. For this OAuthGrantType the control 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 control 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 control 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 control will authenticate as the resource owner. This allows for the control 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 control 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 control 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 control 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 control also clears and populates the Links properties with the new link. When creating a link, you can use the CreateLinkOptions property to set certain options for the link.

When a permission is created using the CreatePermission method, the control 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 property 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 control can also list out the items associated with a specified link. The ListLinkItems method will take a LinkId and populate Items properties.

The control 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 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);

Uploading Files

The UploadFile method uploads new file items.

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 control uses the simple upload mechanism. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

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

When UseResumableUpload is set to and UploadFile is called, a resumable upload session is started by the control. Once called and the control fragments the file, the ResumeURL property is populated. This URL needs to be set so that the control 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 control 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 control is used, they should already be populated, and no special action should be needed). 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");

Additional Functionality

The ShareFile control 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 control with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccountSubdomain Property (ShareFile Control)

Represent a ShareFile domain for the account.

Syntax

sharefilecontrol.AccountSubdomain[=string]

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 Control)

OAuth 2.0 Authorization Token.

Syntax

sharefilecontrol.Authorization[=string]

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

Data Type

String

CreateLinkOptionsAccessLevel Property (ShareFile Control)

The access level for the link.

Syntax

sharefilecontrol.CreateLinkOptionsAccessLevel[=integer]

Possible Values

sflalAnonymous(0), 
sflalUserInfo(1), 
sflalEmployeesAndClients(2), 
sflalEmployeesOnly(3)

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 Control)

The date the link was created.

Syntax

sharefilecontrol.CreateLinkOptionsCreationDate

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 Control)

The expiration date for the link.

Syntax

sharefilecontrol.CreateLinkOptionsExpirationDate[=string]

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 Control)

The id of the link.

Syntax

sharefilecontrol.CreateLinkOptionsId

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 Control)

If the share items can only be viewed.

Syntax

sharefilecontrol.CreateLinkOptionsIsViewOnly[=boolean]

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 Control)

The maximum downloads for a link.

Syntax

sharefilecontrol.CreateLinkOptionsMaxDownloads[=integer]

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 Control)

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

Syntax

sharefilecontrol.CreateLinkOptionsNotifyOnAccess[=boolean]

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 Control)

The title of the link.

Syntax

sharefilecontrol.CreateLinkOptionsTitle[=string]

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 Control)

Total number of times the link has been downloaded from.

Syntax

sharefilecontrol.CreateLinkOptionsTotalDownloads

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 Control)

The link's type.

Syntax

sharefilecontrol.CreateLinkOptionsType

Possible Values

sfltSend(0), 
sfltRequest(1)

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 Control)

The url for the link.

Syntax

sharefilecontrol.CreateLinkOptionsURL

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 Control)

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

Syntax

sharefilecontrol.CreatePermissionOptionsCanDelete[=boolean]

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 Control)

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

Syntax

sharefilecontrol.CreatePermissionOptionsCanDownload[=boolean]

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 Control)

If the user can configure Access Controls in the item.

Syntax

sharefilecontrol.CreatePermissionOptionsCanManagePermissions[=boolean]

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 Control)

Whether the user can upload files to the item.

Syntax

sharefilecontrol.CreatePermissionOptionsCanUpload[=boolean]

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 Control)

If the user can view items from the item.

Syntax

sharefilecontrol.CreatePermissionOptionsCanView[=boolean]

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 Control)

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

Syntax

sharefilecontrol.CreatePermissionOptionsFolderId

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 Control)

If the user is the owner.

Syntax

sharefilecontrol.CreatePermissionOptionsIsOwner

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 Control)

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

Syntax

sharefilecontrol.CreatePermissionOptionsNotifyOnDownload[=boolean]

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 Control)

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

Syntax

sharefilecontrol.CreatePermissionOptionsNotifyOnUpload[=boolean]

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 Control)

The user's ShareFile id.

Syntax

sharefilecontrol.CreatePermissionOptionsUserId

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 Control)

The encryption algorithm.

Syntax

sharefilecontrol.EncryptionAlgorithm[=integer]

Possible Values

eaAES(0), 
eaBlowfish(1), 
eaCAST(2), 
eaDES(3), 
eaIDEA(4), 
eaRC2(5), 
eaRC4(6), 
eaTEA(7), 
eaTripleDES(8), 
eaTwofish(9), 
eaRijndael(10), 
eaChaCha(11), 
eaXSalsa20(12)

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 Control)

The encryption password.

Syntax

sharefilecontrol.EncryptionPassword[=string]

Default Value

""

Remarks

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

The control 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 Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

sharefilecontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (ShareFile Control)

The type of firewall to connect through.

Syntax

sharefilecontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (ShareFile Control)

The name or IP address of the firewall (optional).

Syntax

sharefilecontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the 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 control fails with an error.

Data Type

String

FirewallPassword Property (ShareFile Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

sharefilecontrol.FirewallPassword[=string]

Default Value

""

Remarks

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 control fails with an error.

Data Type

String

FirewallPort Property (ShareFile Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

sharefilecontrol.FirewallPort[=integer]

Default Value

0

Remarks

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 Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

sharefilecontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (ShareFile Control)

The current status of the control.

Syntax

sharefilecontrol.Idle

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

ItemData Property (ShareFile Control)

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

Syntax

sharefilecontrol.ItemData[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ItemDataB.

This property is not available at design time.

Data Type

Binary String

ItemCount Property (ShareFile Control)

The number of records in the Item arrays.

Syntax

sharefilecontrol.ItemCount[=integer]

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 Control)

The date when the item was created.

Syntax

sharefilecontrol.ItemCreationDate(ItemIndex)

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 Control)

The first name of the creator.

Syntax

sharefilecontrol.ItemCreatorFirstName(ItemIndex)

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 Control)

The last name of the creator.

Syntax

sharefilecontrol.ItemCreatorLastName(ItemIndex)

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 Control)

The description of the item.

Syntax

sharefilecontrol.ItemDescription(ItemIndex)[=string]

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 Control)

The expiration date for the item.

Syntax

sharefilecontrol.ItemExpirationDate(ItemIndex)[=string]

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 Control)

The id of the item.

Syntax

sharefilecontrol.ItemId(ItemIndex)

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 Control)

The name of the item.

Syntax

sharefilecontrol.ItemName(ItemIndex)[=string]

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 Control)

The id of the parent item.

Syntax

sharefilecontrol.ItemParentId(ItemIndex)[=string]

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 Control)

The path to the parent folder for an item.

Syntax

sharefilecontrol.ItemPath(ItemIndex)[=string]

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 Control)

The size of the item.

Syntax

sharefilecontrol.ItemSize(ItemIndex)

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 Control)

The item's type.

Syntax

sharefilecontrol.ItemType(ItemIndex)

Possible Values

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

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 Control)

The number of records in the Link arrays.

Syntax

sharefilecontrol.LinkCount[=integer]

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 Control)

The access level for the link.

Syntax

sharefilecontrol.LinkAccessLevel(LinkIndex)[=integer]

Possible Values

sflalAnonymous(0), 
sflalUserInfo(1), 
sflalEmployeesAndClients(2), 
sflalEmployeesOnly(3)

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 Control)

The date the link was created.

Syntax

sharefilecontrol.LinkCreationDate(LinkIndex)

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 Control)

The expiration date for the link.

Syntax

sharefilecontrol.LinkExpirationDate(LinkIndex)[=string]

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 Control)

The id of the link.

Syntax

sharefilecontrol.LinkId(LinkIndex)

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 Control)

If the share items can only be viewed.

Syntax

sharefilecontrol.LinkIsViewOnly(LinkIndex)[=boolean]

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 Control)

The maximum downloads for a link.

Syntax

sharefilecontrol.LinkMaxDownloads(LinkIndex)[=integer]

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 Control)

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

Syntax

sharefilecontrol.LinkNotifyOnAccess(LinkIndex)[=boolean]

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 Control)

The title of the link.

Syntax

sharefilecontrol.LinkTitle(LinkIndex)[=string]

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 Control)

Total number of times the link has been downloaded from.

Syntax

sharefilecontrol.LinkTotalDownloads(LinkIndex)

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 Control)

The link's type.

Syntax

sharefilecontrol.LinkType(LinkIndex)

Possible Values

sfltSend(0), 
sfltRequest(1)

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 Control)

The url for the link.

Syntax

sharefilecontrol.LinkURL(LinkIndex)

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 Control)

The location of the local file.

Syntax

sharefilecontrol.LocalFile[=string]

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.

Data Type

String

LocalHost Property (ShareFile Control)

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

Syntax

sharefilecontrol.LocalHost[=string]

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control 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 multihomed 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 Control)

The access token returned by the authorization server.

Syntax

sharefilecontrol.OAuthAccessToken[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (ShareFile Control)

The authorization code that is exchanged for an access token.

Syntax

sharefilecontrol.OAuthAuthorizationCode[=string]

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 Control)

The scope request or response parameter used during authorization.

Syntax

sharefilecontrol.OAuthAuthorizationScope[=string]

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 Control)

The id of the client assigned when registering the application.

Syntax

sharefilecontrol.OAuthClientId[=string]

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 Control)

The type of client that is requesting authorization.

Syntax

sharefilecontrol.OAuthClientProfile[=integer]

Possible Values

cocpApplication(0), 
cocpWeb(1)

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 Control)

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

Syntax

sharefilecontrol.OAuthClientSecret[=string]

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 Control)

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

Syntax

sharefilecontrol.OAuthGrantType[=integer]

Possible Values

cogtAuthorizationCode(0), 
cogtImplicit(1), 
cogtPassword(2), 
cogtClientCredentials(3)

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 Control)

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

Syntax

sharefilecontrol.OAuthRefreshToken[=string]

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

OAuthRequestRefreshToken Property (ShareFile Control)

Specifies whether the control will request a refresh token during authorization.

Syntax

sharefilecontrol.OAuthRequestRefreshToken[=boolean]

Default Value

True

Remarks

Specifies whether the control will request a refresh token during authorization. By default, this value is True.

When True, the control will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (ShareFile Control)

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

Syntax

sharefilecontrol.OAuthReturnURL[=string]

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 control 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 Control)

The URL of the authorization server.

Syntax

sharefilecontrol.OAuthServerAuthURL[=string]

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (ShareFile Control)

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

Syntax

sharefilecontrol.OAuthServerTokenURL[=string]

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 Control)

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

Syntax

sharefilecontrol.OAuthWebAuthURL

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 Control)

Other headers as determined by the user (optional).

Syntax

sharefilecontrol.OtherHeaders[=string]

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 (Chr$(13) & Chr$(10)) .

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 control beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (ShareFile Control)

Whether to overwrite the local or remote file.

Syntax

sharefilecontrol.Overwrite[=boolean]

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 Control)

The number of records in the ParsedHeader arrays.

Syntax

sharefilecontrol.ParsedHeaderCount

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 Control)

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

Syntax

sharefilecontrol.ParsedHeaderField(ParsedHeaderIndex)

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 Control)

This property contains the header contents.

Syntax

sharefilecontrol.ParsedHeaderValue(ParsedHeaderIndex)

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 Control)

The number of records in the Permission arrays.

Syntax

sharefilecontrol.PermissionCount[=integer]

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 Control)

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

Syntax

sharefilecontrol.PermissionCanDelete(PermissionIndex)[=boolean]

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 Control)

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

Syntax

sharefilecontrol.PermissionCanDownload(PermissionIndex)[=boolean]

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 Control)

If the user can configure Access Controls in the item.

Syntax

sharefilecontrol.PermissionCanManagePermissions(PermissionIndex)[=boolean]

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 Control)

Whether the user can upload files to the item.

Syntax

sharefilecontrol.PermissionCanUpload(PermissionIndex)[=boolean]

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 Control)

If the user can view items from the item.

Syntax

sharefilecontrol.PermissionCanView(PermissionIndex)[=boolean]

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 Control)

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

Syntax

sharefilecontrol.PermissionFolderId(PermissionIndex)

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 Control)

If the user is the owner.

Syntax

sharefilecontrol.PermissionIsOwner(PermissionIndex)

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 Control)

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

Syntax

sharefilecontrol.PermissionNotifyOnDownload(PermissionIndex)[=boolean]

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 Control)

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

Syntax

sharefilecontrol.PermissionNotifyOnUpload(PermissionIndex)[=boolean]

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 Control)

The user's ShareFile id.

Syntax

sharefilecontrol.PermissionUserId(PermissionIndex)

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 Control)

The type of authorization to perform when connecting to the proxy.

Syntax

sharefilecontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The 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 control 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 control. Look at the configuration file for the control 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 Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

sharefilecontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (ShareFile Control)

A password if authentication is to be used for the proxy.

Syntax

sharefilecontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password 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

ProxyPort Property (ShareFile Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

sharefilecontrol.ProxyPort[=integer]

Default Value

80

Remarks

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 Control)

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

Syntax

sharefilecontrol.ProxyServer[=string]

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 Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

sharefilecontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

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 Control)

A username if authentication is to be used for the proxy.

Syntax

sharefilecontrol.ProxyUser[=string]

Default Value

""

Remarks

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 Control)

The number of records in the QueryParam arrays.

Syntax

sharefilecontrol.QueryParamCount[=integer]

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 Control)

The name of the query parameter.

Syntax

sharefilecontrol.QueryParamName(QueryParamIndex)[=string]

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 Control)

The value of the query parameter.

Syntax

sharefilecontrol.QueryParamValue(QueryParamIndex)[=string]

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The control 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 Control)

The resumable upload URL.

Syntax

sharefilecontrol.ResumeURL[=string]

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the control automatically when UseResumableUpload is set to 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 Control)

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

Syntax

sharefilecontrol.SearchMarker[=integer]

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

SSLAcceptServerCertEffectiveDate Property (ShareFile Control)

The date on which this certificate becomes valid.

Syntax

sharefilecontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (ShareFile Control)

The date on which the certificate expires.

Syntax

sharefilecontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (ShareFile Control)

A comma-delimited list of extended key usage identifiers.

Syntax

sharefilecontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (ShareFile Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (ShareFile Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (ShareFile Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (ShareFile Control)

The issuer of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (ShareFile Control)

The private key of the certificate (if available).

Syntax

sharefilecontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (ShareFile Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (ShareFile Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

sharefilecontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (ShareFile Control)

The public key of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (ShareFile Control)

The textual description of the certificate's public key algorithm.

Syntax

sharefilecontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (ShareFile Control)

The length of the certificate's public key (in bits).

Syntax

sharefilecontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (ShareFile Control)

The serial number of the certificate encoded as a string.

Syntax

sharefilecontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (ShareFile Control)

The text description of the certificate's signature algorithm.

Syntax

sharefilecontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (ShareFile Control)

The name of the certificate store for the client certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (ShareFile Control)

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

Syntax

sharefilecontrol.SSLAcceptServerCertStorePassword[=string]

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

SSLAcceptServerCertStoreType Property (ShareFile Control)

The type of certificate store for this certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (ShareFile Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (ShareFile Control)

The MD5 hash of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (ShareFile Control)

The SHA-1 hash of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (ShareFile Control)

The SHA-256 hash of the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (ShareFile Control)

The text description of UsageFlags .

Syntax

sharefilecontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (ShareFile Control)

The flags that show intended use for the certificate.

Syntax

sharefilecontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (ShareFile Control)

The certificate's version number.

Syntax

sharefilecontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (ShareFile Control)

The subject of the certificate used for client authentication.

Syntax

sharefilecontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

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

SSLAcceptServerCertEncoded Property (ShareFile Control)

The certificate (PEM/Base64 encoded).

Syntax

sharefilecontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (ShareFile Control)

The date on which this certificate becomes valid.

Syntax

sharefilecontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (ShareFile Control)

The date on which the certificate expires.

Syntax

sharefilecontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (ShareFile Control)

A comma-delimited list of extended key usage identifiers.

Syntax

sharefilecontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (ShareFile Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (ShareFile Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (ShareFile Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (ShareFile Control)

The issuer of the certificate.

Syntax

sharefilecontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (ShareFile Control)

The private key of the certificate (if available).

Syntax

sharefilecontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (ShareFile Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

sharefilecontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (ShareFile Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

sharefilecontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (ShareFile Control)

The public key of the certificate.

Syntax

sharefilecontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (ShareFile Control)

The textual description of the certificate's public key algorithm.

Syntax

sharefilecontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (ShareFile Control)

The length of the certificate's public key (in bits).

Syntax

sharefilecontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (ShareFile Control)

The serial number of the certificate encoded as a string.

Syntax

sharefilecontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (ShareFile Control)

The text description of the certificate's signature algorithm.

Syntax

sharefilecontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (ShareFile Control)

The name of the certificate store for the client certificate.

Syntax

sharefilecontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (ShareFile Control)

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

Syntax

sharefilecontrol.SSLCertStorePassword[=string]

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 Control)

The type of certificate store for this certificate.

Syntax

sharefilecontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (ShareFile Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

sharefilecontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (ShareFile Control)

The MD5 hash of the certificate.

Syntax

sharefilecontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (ShareFile Control)

The SHA-1 hash of the certificate.

Syntax

sharefilecontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (ShareFile Control)

The SHA-256 hash of the certificate.

Syntax

sharefilecontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (ShareFile Control)

The text description of UsageFlags .

Syntax

sharefilecontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (ShareFile Control)

The flags that show intended use for the certificate.

Syntax

sharefilecontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (ShareFile Control)

The certificate's version number.

Syntax

sharefilecontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (ShareFile Control)

The subject of the certificate used for client authentication.

Syntax

sharefilecontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

SSLCertEncoded Property (ShareFile Control)

The certificate (PEM/Base64 encoded).

Syntax

sharefilecontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (ShareFile Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

sharefilecontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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 as follows:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (ShareFile Control)

The date on which this certificate becomes valid.

Syntax

sharefilecontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (ShareFile Control)

The date on which the certificate expires.

Syntax

sharefilecontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (ShareFile Control)

A comma-delimited list of extended key usage identifiers.

Syntax

sharefilecontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (ShareFile Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (ShareFile Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (ShareFile Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

sharefilecontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (ShareFile Control)

The issuer of the certificate.

Syntax

sharefilecontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (ShareFile Control)

The private key of the certificate (if available).

Syntax

sharefilecontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (ShareFile Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

sharefilecontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (ShareFile Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

sharefilecontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (ShareFile Control)

The public key of the certificate.

Syntax

sharefilecontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (ShareFile Control)

The textual description of the certificate's public key algorithm.

Syntax

sharefilecontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (ShareFile Control)

The length of the certificate's public key (in bits).

Syntax

sharefilecontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (ShareFile Control)

The serial number of the certificate encoded as a string.

Syntax

sharefilecontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (ShareFile Control)

The text description of the certificate's signature algorithm.

Syntax

sharefilecontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (ShareFile Control)

The name of the certificate store for the client certificate.

Syntax

sharefilecontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (ShareFile Control)

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

Syntax

sharefilecontrol.SSLServerCertStorePassword

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (ShareFile Control)

The type of certificate store for this certificate.

Syntax

sharefilecontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (ShareFile Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

sharefilecontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (ShareFile Control)

The MD5 hash of the certificate.

Syntax

sharefilecontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (ShareFile Control)

The SHA-1 hash of the certificate.

Syntax

sharefilecontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (ShareFile Control)

The SHA-256 hash of the certificate.

Syntax

sharefilecontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (ShareFile Control)

The text description of UsageFlags .

Syntax

sharefilecontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (ShareFile Control)

The flags that show intended use for the certificate.

Syntax

sharefilecontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (ShareFile Control)

The certificate's version number.

Syntax

sharefilecontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (ShareFile Control)

The subject of the certificate used for client authentication.

Syntax

sharefilecontrol.SSLServerCertSubject

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (ShareFile Control)

The certificate (PEM/Base64 encoded).

Syntax

sharefilecontrol.SSLServerCertEncoded

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

StartByte Property (ShareFile Control)

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

Syntax

sharefilecontrol.StartByte[=long64]

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (ShareFile Control)

The timeout for the control.

Syntax

sharefilecontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (ShareFile Control)

Whether to use resumable uploads.

Syntax

sharefilecontrol.UseResumableUpload[=boolean]

Default Value

False

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

UserCount Property (ShareFile Control)

The number of records in the User arrays.

Syntax

sharefilecontrol.UserCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserCompany
• UserCreationDate
• UserEmail
• UserFirstName
• UserId
• UserLastName

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

This property is not available at design time.

Data Type

Integer

UserCompany Property (ShareFile Control)

The company of the user.

Syntax

sharefilecontrol.UserCompany(UserIndex)[=string]

Default Value

""

Remarks

The company of the user.

This property specifies the company of the user. This is an optional field. To modify this property see UpdateClient.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCreationDate Property (ShareFile Control)

The date the user was created.

Syntax

sharefilecontrol.UserCreationDate(UserIndex)

Default Value

""

Remarks

The date the user was created.

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

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

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

Data Type

String

UserEmail Property (ShareFile Control)

The email address of the user.

Syntax

sharefilecontrol.UserEmail(UserIndex)[=string]

Default Value

""

Remarks

The email address of the user.

This property specifies the email address of the user. To modify this property see UpdateClient.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserFirstName Property (ShareFile Control)

The first name of the user.

Syntax

sharefilecontrol.UserFirstName(UserIndex)[=string]

Default Value

""

Remarks

The first name of the user.

This property specifies the first name of the user. To modify this property see UpdateClient.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserId Property (ShareFile Control)

The id of the user.

Syntax

sharefilecontrol.UserId(UserIndex)

Default Value

""

Remarks

The id of the user.

This property specifies the id of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

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

Data Type

String

UserLastName Property (ShareFile Control)

The last name of the user.

Syntax

sharefilecontrol.UserLastName(UserIndex)[=string]

Default Value

""

Remarks

The last name of the user.

This property specifies the last name of the user. To modify this property see UpdateClient.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

AddQueryParam Method (ShareFile Control)

Adds a query parameter to the QueryParams properties.

Syntax

sharefilecontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the control automatically. Consult the service documentation for details on the available parameters.

Authorize Method (ShareFile Control)

Get the authorization string required to access the protected resource.

Syntax

sharefilecontrol.Authorize 

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

CalcAuthorization Method (ShareFile Control)

Calculates the Authorization header based on provided credentials.

Syntax

sharefilecontrol.CalcAuthorization 

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The control will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

Config Method (ShareFile Control)

Sets or retrieves a configuration setting.

Syntax

sharefilecontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyItem Method (ShareFile Control)

Copies the specified item into the specified directory.

Syntax

sharefilecontrol.CopyItem ItemId, ParentId

Remarks

This method copies the file identified by ItemId to the directory specified by ParentId and returns the Id of the newly created copy. Must call ListItems or GetItemInfo before the Items properties will be updated with the copied item.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

CreateAndEmailLink Method (ShareFile Control)

Creates a link for specified items and emails it.

Syntax

sharefilecontrol.CreateAndEmailLink ItemIds, emails, subject, note

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new link. After doing so it will also send the emails with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note is added as a note within the body of the email. CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a ItemIds to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

CreateAndEmailRequestLink Method (ShareFile Control)

Creates a new request link and emails it to the specified emails.

Syntax

sharefilecontrol.CreateAndEmailRequestLink FolderId, emails, subject, note

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new request link. After doing so it will also send the emails with the new request link. FolderId is the ID of the directory where the files will be uploaded in ShareFile. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note id added as a note within the body of the email. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

CreateClient Method (ShareFile Control)

Creates a new client.

Syntax

sharefilecontrol.CreateClient FirstName, LastName, Email, Company

Remarks

Creates a new client user and returns the new client id as a string. The Users properties will not be updated with the new client until the ListUsers or GetUserInfo methods are called. FirstName, LastName, and Email are required to create a client. Company can be left empty. // Creates a client named John Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("John", "Brown", "example@example.com", "");

CreateFolder Method (ShareFile Control)

Creates a new folder.

Syntax

sharefilecontrol.CreateFolder Name, ParentId

Remarks

Creates a new folder and returns the new folder's itemId as a string. Must call ListItems or GetItemInfo before the Items properties will be updated with the new folder. Name is the name of the folder. ParentId is the id of the parent folder to the newly-created folder.

Note that the string root may be used as a folder Id to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

CreateLink Method (ShareFile Control)

Creates a new link for specified items.

Syntax

sharefilecontrol.CreateLink ItemIds

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a ItemIds to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

CreatePermission Method (ShareFile Control)

Create a new Permissions for the specified folder and user.

Syntax

sharefilecontrol.CreatePermission FolderId, UserId, Recursive

Remarks

Creates a new permission for a specified folder and user. The Permissions properties will not be updated with the new permission until the ListPermissions or GetPermissionInfo methods are called. FolderId is the id of the folder to add the permission to. UserId is the id of the user who will be getting the new permission. Recursive is to true when the user needs permission for all sub-folders within the specified folder. The CreatePermissionOptions property can be used to specify the different options for the newly created permission.

The CreatePermissionNotify and CreatePermissionNotifyMessage configurations can be used to notify the user at the email set in the ShareFilePermission type. string FolderId = shareFile.CreateFolder("test", "home"); string UserId = CreateUser("First", "Last", example@example.com, "company"); shareFile.Config("CreatePermissionNotify=True"); shareFile.Config("CreatePermissionNotifyMessage=CreatePermissionNotifyConfigTest"); shareFile.CreatePermission(FolderId, UserId, true);

CreateRequestLink Method (ShareFile Control)

Creates a new request link.

Syntax

sharefilecontrol.CreateRequestLink FolderId

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new request link. It will also return the new request link as a string. FolderId is the ID for the directory where the files will be uploaded in ShareFile. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

DeleteChildItems Method (ShareFile Control)

Removes multiple items from a parent item.

Syntax

sharefilecontrol.DeleteChildItems ParentId, ItemIds

Remarks

This method deletes multiple files or folders specified by ItemIds permanently. ParentId is the id of the parent item that contains the items that should be deleted. ItemIds is a comma separated list of ItemIds that are going to be deleted permanently. The items must be a child to the specified parent.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

DeleteClient Method (ShareFile Control)

Deletes a client from the user list.

Syntax

sharefilecontrol.DeleteClient UserId

Remarks

Deletes a client from the user list. Must call ListUsers before the Users properties will be updated. UserId is the id for the user that is going to be deleted. // Deletes the first user. shareFile.ListUsers(); string UserId = shareFile.Users[0].Id; shareFile.DeleteClient(UserId);

DeleteItem Method (ShareFile Control)

Deletes an item permanently.

Syntax

sharefilecontrol.DeleteItem ItemId

Remarks

This method deletes the item specified by ItemId permanently. Must call ListItems before the Items properties property will be updated. // Deletes the first item. shareFile.ListItems(); string ItemId = shareFile.Items[0].Id; shareFile.DeleteItem(ItemId);

DeleteLink Method (ShareFile Control)

Deletes the link specified by the LinkId.

Syntax

sharefilecontrol.DeleteLink LinkId

Remarks

Deletes the link specified by the LinkId permanently. The Links properties will not be updated until the ListLinks method is called. // Deletes the first link. shareFile.ListLinks(); string LinkId = shareFile.Link[0].Id; shareFile.DeleteLink(LinkId);

DeletePermission Method (ShareFile Control)

Removes a users permissions for a specific folder.

Syntax

sharefilecontrol.DeletePermission FolderId, UserId

Remarks

The method will remove a users permission for a specific folder. FolderId is the id of the folder that is having its permissions changed. UserId is the ID of the user that is getting permissions removed for the folder. Once the method is complete, the ListPermissions method must be called to update the Permissions properties. // Deletes the first permission. shareFile.ListPermissions(); string FolderId = shareFile.Link[0].FolderId; string UserId = shareFile.Link[0].UserId; shareFile.DeleteLink(FolderId, UserId);

DownloadFile Method (ShareFile Control)

This method downloads the file or the contents of the folder specified by the ItemId.

Syntax

sharefilecontrol.DownloadFile ItemId

Remarks

The method will download the item specified by the ItemId. If LocalFile is set, the file or folder will be saved to the specified location. Otherwise, the control will use the data from the ItemData property; If the item is a directory, it will download the contents (recursively) of the directory as a ZIP file.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

Name Conflict Resolution

If the Overwrite property is set to true, then the control will overwrite a file if one is found at the location specified by the LocalFile property. If it is set to false, then the control will throw an error if it finds a collision.

If 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);

GetItemInfo Method (ShareFile Control)

Gets information about a specific item.

Syntax

sharefilecontrol.GetItemInfo ItemId

Remarks

Calling this method will fire the ItemList event, and will populate the Items properties (clearing any previously-held items in the process)

ItemId is the id of the items that the control will get the information for. If the method is supplied a path (for ex. "/parentFolder/ChildFolder") then the control will use the path to get the item information.

Passing an ID string dirId = shareFile.CreateFolder("NewFolder", "home"); shareFile.GetItemInfo(dirId); Passing a path string dirId = shareFile.CreateFolder("NewFolder", "allshared"); shareFile.GetItemInfo("/NewFolder");

GetLinkInfo Method (ShareFile Control)

Gets information about a specific link.

Syntax

sharefilecontrol.GetLinkInfo LinkId

Remarks

Calling this method will fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process). LinkId is the id for the link that the control will get the information for. string linkId = shareFile.Links[0].Id; shareFile.GetLinkInfo(linkId);

GetPermissionInfo Method (ShareFile Control)

Gets information about a specific user's permission for a folder.

Syntax

sharefilecontrol.GetPermissionInfo FolderId, UserId

Remarks

Calling this method will fire the PermissionList event, and will populate the Permissions properties (clearing any previously-held items in the process). FolderId is the item Id for the folder and UserId is the user Id for the user. string userId = shareFile.Users[0]; string folderId = shareFile.Items[0]; shareFile.GetPermissionInfo(folderId, userId);

GetUserInfo Method (ShareFile Control)

Gets information about a specific user.

Syntax

sharefilecontrol.GetUserInfo UserId

Remarks

This method can accept the Id of a user, or the user's email through the UserId property. Calling this method will fire the UserList event once for the user, and will populate the Users properties (clearing any previously-held items in the process). string userId = shareFile.Users.Id; shareFile.getUserInfo(userId);

Interrupt Method (ShareFile Control)

This method interrupts the current method.

Syntax

sharefilecontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListItems Method (ShareFile Control)

Lists the files and folders within a folder.

Syntax

sharefilecontrol.ListItems FolderId

Remarks

The method takes a string FolderId which represents the ID of the folder that the control will list from. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

ListLinkItems Method (ShareFile Control)

Lists the files and folders of a link.

Syntax

sharefilecontrol.ListLinkItems LinkId

Remarks

Lists the items contained within the link. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

The items listed are not listed recursively. To get the items contained within folder items, further calls can be done using the ListItems method. string linkId = shareFile.Links[0].Id; shareFile.ListLinkItems(linkId);

ListLinks Method (ShareFile Control)

Lists the request/download links for the currently authenticated user.

Syntax

sharefilecontrol.ListLinks 

Remarks

The method will list the request/download links for currently authenticated user. Calling this method will fire the LinkList event once for each link, and will also populate the Links properties.

Calling this method won't return the items of a link, but ListLinkItems can be used to get the items of the link.

ListPermissions Method (ShareFile Control)

Lists the permissions of a folder.

Syntax

sharefilecontrol.ListPermissions FolderId

Remarks

The method will list the permissions of a folder defined by the FolderId parameter. Calling this method will fire the PermissionList event once for each permission, and will also populate the Permissions properties. string FolderId = shareFile.Items[0].Id; shareFile.ListPermissions(FolderId);

ListUsers Method (ShareFile Control)

Lists the client users of the authenticated account.

Syntax

sharefilecontrol.ListUsers 

Remarks

Calling this method will fire the UserList event once for each client user, and will also populate the Users properties.

MoveItem Method (ShareFile Control)

Moves an item to a different folder.

Syntax

sharefilecontrol.MoveItem ItemId, ParentId, NewName

Remarks

This method will move the item, specified by the ItemId string, and moves it to a new folder, specified by the ParentId. NewName specifies the new name of the item; if empty, the item's original name is used.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

Reset Method (ShareFile Control)

Resets the control to its initial state.

Syntax

sharefilecontrol.Reset 

Remarks

This method resets the control to its initial state.

Search Method (ShareFile Control)

Searches for items that match the specified query.

Syntax

sharefilecontrol.Search Query

Remarks

This method searches for items that match the given Query parameter. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

As a note, this method makes a request to the simple search endpoint, rather than the advanced search endpoint.

shareFile.Search("Test.txt");

SendCustomRequest Method (ShareFile Control)

Sends a custom request to the ShareFile API.

Syntax

sharefilecontrol.SendCustomRequest HttpMethod, RequestPath, RequestBody

Remarks

This method can be used to send arbitrary requests to the ShareFile API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

Usage

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the ShareFile API's stable endpoint, https://[SUBDOMAIN].sf-api.com/sf/v3.
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the specified LocalFile (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

UpdateClient Method (ShareFile Control)

Updates a client's information.

Syntax

sharefilecontrol.UpdateClient UserId, FirstName, LastName, Email, Company

Remarks

Updates a clients first name, last name, email, and/or company. UserId represents the string Id for the client that will be updated. FirstName, LastName, Email, and Company each represents the update value for their corresponding ShareFileUser field.

Passing an empty string for FirstName, LastName, Email, or Company will mean that the field will not be updated. // Creates a client named FirstName Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("FirstName", "Brown", "example@example.com", ""); // Updates the First name of the client to John and sets a company, leave everything else the same. shareFile.UpdateClient(userId, "John", "", "", "nsoftware");

UpdateItemInfo Method (ShareFile Control)

Updates an item with new information.

Syntax

sharefilecontrol.UpdateItemInfo ItemId

Remarks

This method updates the item information for an item identified by ItemId. The item should be in the Items properties and should be modified from there.

The following properties can be updated from the ShareFileItem type:

• Description
• ExpirationTime
• Name
• ParentId

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• home
• favorites
• allshared
• connectors
• box
• top.

UpdateLink Method (ShareFile Control)

Updates a request or download link.

Syntax

sharefilecontrol.UpdateLink LinkId

Remarks

This method updates the link information for a link identified by LinkId. The the control requires the link to be in the Links properties and be modified from there.

The following properties can be updated from the ShareFileLink type:

• ExpirationDate
• MaxDownloads
• Name
• RequireLogin
• Title

// Updates a link to require login. shareFile.Links[1].RequireLogin = true; shareFile.UpdateLink(shareFile.Links[1].Id);

UpdatePermission Method (ShareFile Control)

Updates the permission from the Permissions properties.

Syntax

sharefilecontrol.UpdatePermission Index, Recursive

Remarks

The permission at Index in the Permissions properties will be updated.

The following properties can be updated from the ShareFilePermission type:

• CanDelete
• CanDownload
• CanManagePermissions
• CanUpload
• CanView
• NotifyOnDownload
• NotifyOnUpload

UploadFile Method (ShareFile Control)

Will upload a file to a folder.

Syntax

sharefilecontrol.UploadFile FileName, ParentId

Remarks

The method when called will upload a file specified in the LocalFile property. If LocalFile has not been set then the control will use the data found in the ItemData property; The file will be uploaded to the folder specified by the ParentId parameter. The name of the file will be what is passed to the FileName parameter. Once it has completed uploading it will return the id of the uploaded file.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

Name Conflict Resolution

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 control uses the simple upload mechanism. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

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

When UseResumableUpload is set to and UploadFile is called, a resumable upload session is started by the control. Once called and the control fragments the file, the ResumeURL property is populated. This URL needs to be set so that the control 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 control 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 control is used, they should already be populated, and no special action should be needed). 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");

EndTransfer Event (ShareFile Control)

This event fires when a document finishes transferring.

Syntax

Sub sharefilecontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (ShareFile Control)

Fired when information is available about errors during data delivery.

Syntax

Sub sharefilecontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (ShareFile Control)

Fires after each fragment of a resumable upload is completed.

Syntax

Sub sharefilecontrol_FragmentComplete(FragmentNumber As Integer, FragmentCount As Integer, Interrupt As Boolean)

Remarks

When UseResumableUpload is and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to to interrupt the upload. The upload may be resumed later.

Header Event (ShareFile Control)

Fired every time a header line comes in.

Syntax

Sub sharefilecontrol_Header(Field As String, Value As String)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

ItemList Event (ShareFile Control)

This event fires once for each item returned when either ListItems , ListLinkItems or GetItemInfo is called.

Syntax

Sub sharefilecontrol_ItemList(Id As String, Name As String, Path As String, CreatorFirstName As String, CreatorLastName As String, ItemType As Integer, ParentId As String, Description As String, ExpirationDate As String, CreationDate As String, Size As Long64)

Remarks

This event fires once for each item returned when either ListItems, ListLinkItems or GetItemInfo is called. The items cannot be modified from this event.

LinkList Event (ShareFile Control)

This event fires once for each link returned when ListLinks or GetLinkInfo is called.

Syntax

Sub sharefilecontrol_LinkList(Id As String, Title As String, URL As String, LinkType As Integer, AccessLevel As Integer, ExpirationDate As String, CreationDate As String, IsViewOnly As Boolean, MaxDownloads As Integer, TotalDownloads As Integer, NotifyOnAccess As Boolean)

Remarks

This event fires once for each link returned when ListLinks or GetLinkInfo is called. The link cannot be modified from this event. This event will not show the items related to the specific link when calling ListLinkItems. Those will be listed using the ItemList event.

Log Event (ShareFile Control)

Fired once for each log message.

Syntax

Sub sharefilecontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

PermissionList Event (ShareFile Control)

This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called.

Syntax

Sub sharefilecontrol_PermissionList(FolderId As String, UserId As String, CanDelete As Boolean, CanDownload As Boolean, CanManagePermissions As Boolean, CanUpload As Boolean, CanView As Boolean, IsOwner As Boolean, NotifyOnDownload As Boolean, NotifyOnUpload As Boolean)

Remarks

This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called. The permissions cannot be modified from this event. The FolderId represents the item Id for the specific folder the permission is for. The UserId represents the Id for the user the permission is for.

Progress Event (ShareFile Control)

Fires during an upload or download to indicate transfer progress.

Syntax

Sub sharefilecontrol_Progress(Direction As Integer, BytesTransferred As Long64, TotalBytes As Long64, PercentDone As Integer)

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the control tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the control will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (ShareFile Control)

Fired after the server presents its certificate to the client.

Syntax

Sub sharefilecontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (ShareFile Control)

Fired when secure connection progress messages are available.

Syntax

Sub sharefilecontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (ShareFile Control)

This event fires when a document starts transferring (after the headers).

Syntax

Sub sharefilecontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (ShareFile Control)

Fired while a document transfers (delivers document).

Syntax

Sub sharefilecontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

UserList Event (ShareFile Control)

This event fires once for each user returned when ListUsers or GetUserInfo is called.

Syntax

Sub sharefilecontrol_UserList(Id As String, FirstName As String, LastName As String, Company As String, Email As String, CreationDate As String)

Remarks

This event fires once for each user returned when ListUsers or GetUserInfo is called. The users cannot be modified from this event. If the user does not have a specified company that parameter will be left as an empty string ("").

Config Settings (ShareFile Control)

ShareFile Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings