Wasabi Control

Properties   Methods   Events   Config Settings   Errors  

The Wasabi control provides an easy way to interface with the Wasabi service.

Syntax

Wasabi

Remarks

Wasabi has an API that is fully compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses. Wasabi adds additional functionality on top of the S3 API. Whether you're doing simple bucket-and-object data manipulation, or leveraging Wasabi-exclusive API features, the Wasabi control makes it easy to access the Wasabi service quickly and securely.

Wasabi's API additions range in scale; the simplest example is the ability to rename buckets, objects, and folders. The most notable API additions, however, are two full-blown headline features: Composition and Compliance. Composition allows you to concatenate (or, "compose") together objects which are already on the server; it's a simpler, cheaper, and more flexible alternative to S3's multipart uploads. The Compliance system gives you the ability to define policies that dictate how long objects must be retained before they can be modified or deleted. We recommend referring to Wasabi's website for more details about these features.

To use the Wasabi control, you will first need to sign up for the Wasabi service and obtain an AccessKey and a SecretKey. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

The ComposeObjects and UpdateCompliance methods' documentation provide extensive usage details and examples for composition and compliance; the RenameBucket, RenameObject, and RenameFolder methods speak for themselves; and the standard bucket-and-object manipulation features are available through methods such as ListBuckets, ListObjects, GetObject, DeleteObject, GetLink, 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.

AccessKey Property (Wasabi Control)

The access key to use for authentication.

Syntax

wasabicontrol.AccessKey[=string]

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

AccessPolicy Property (Wasabi Control)

The canned access policy to apply to a bucket or object.

Syntax

wasabicontrol.AccessPolicy[=integer]

Possible Values

ptPrivate(0), 
ptPublicRead(1), 
ptPublicReadWrite(2), 
ptAuthenticatedRead(3), 
ptBucketOwnerRead(4), 
ptBucketOwnerFullControl(5), 
ptNone(6)

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

Valid values are:

Data Type

Integer

Bucket Property (Wasabi Control)

Selects a bucket.

Syntax

wasabicontrol.Bucket[=string]

Default Value

""

Remarks

This property selects a bucket, by name, for the control to operate against. It must be set before attempting most operations.

Data Type

String

BucketComplianceConditionalHold Property (Wasabi Control)

Signifies whether new objects created in a bucket will be placed under conditional hold.

Syntax

wasabicontrol.BucketComplianceConditionalHold[=string]

Default Value

""

Remarks

Signifies whether new objects created in a bucket will be placed under conditional hold.

Setting this to "false" will not release objects from their conditional holds, it will only prevent conditional holds from being placed on any newly-created objects.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

BucketComplianceDeleteAfterRetention Property (Wasabi Control)

Whether or not objects should be deleted immediately once their retention period expires.

Syntax

wasabicontrol.BucketComplianceDeleteAfterRetention[=string]

Default Value

""

Remarks

Whether or not objects should be deleted immediately once their retention period expires.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

BucketComplianceIsLocked Property (Wasabi Control)

Signifies whether the current bucket's compliance settings are locked or not.

Syntax

wasabicontrol.BucketComplianceIsLocked

Default Value

""

Remarks

Signifies whether the current bucket's compliance settings are locked or not.

Refer to the UpdateCompliance documentation for more information about compliance.

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

Data Type

String

BucketComplianceLockTime Property (Wasabi Control)

Specifies when a bucket's compliance settings are locked.

Syntax

wasabicontrol.BucketComplianceLockTime[=string]

Default Value

""

Remarks

Specifies when a bucket's compliance settings are locked.

When a bucket's compliance settings are locked, certain compliance settings cannot be changed any further. Wasabi defaults this value to "off"; other valid values are "now" to immediately lock the compliance settings, or an ISO 8601 date-time string.

Important: Locking the compliance settings on a bucket is a one-way action. You cannot unlock a bucket's compliance settings without contacting the Wasabi support team. Refer to the Wasabi documentation for more information.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

BucketComplianceRetentionDays Property (Wasabi Control)

Specifies the minimum number of days objects must be retained before they can be deleted.

Syntax

wasabicontrol.BucketComplianceRetentionDays[=integer]

Default Value

-1

Remarks

Specifies the minimum number of days objects must be retained before they can be deleted.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

Integer

BucketComplianceStatus Property (Wasabi Control)

Whether or not the a bucket has compliance settings enabled.

Syntax

wasabicontrol.BucketComplianceStatus[=string]

Default Value

""

Remarks

Whether or not the a bucket has compliance settings enabled.

Setting this to "enabled" and calling UpdateCompliance will enable compliance for the current bucket. If this is set to "disabled", all other bucket compliance settings will be ignored when UpdateCompliance is called.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

BucketsCount Property (Wasabi Control)

The number of records in the Buckets arrays.

Syntax

wasabicontrol.BucketsCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketsCreationDate
• BucketsName
• BucketsOwnerDisplayName
• BucketsOwnerId

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

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

Data Type

Integer

BucketsCreationDate Property (Wasabi Control)

The property includes the creation date of the bucket.

Syntax

wasabicontrol.BucketsCreationDate(BucketsIndex)

Default Value

""

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsName Property (Wasabi Control)

The property contains the name of the bucket.

Syntax

wasabicontrol.BucketsName(BucketsIndex)

Default Value

""

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsOwnerDisplayName Property (Wasabi Control)

The property contains the display name of the bucket's owner.

Syntax

wasabicontrol.BucketsOwnerDisplayName(BucketsIndex)

Default Value

""

Remarks

The property contains the display name of the bucket's owner.

This property reflects the display name of the bucket's owner.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsOwnerId Property (Wasabi Control)

The property contains the Id of the bucket's owner.

Syntax

wasabicontrol.BucketsOwnerId(BucketsIndex)

Default Value

""

Remarks

The property contains the Id of the bucket's owner.

This property reflects the Id of the bucket's owner.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

ContentDisposition Property (Wasabi Control)

Content disposition to send for an object.

Syntax

wasabicontrol.ContentDisposition[=string]

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

ContentType Property (Wasabi Control)

Content type to send for an object.

Syntax

wasabicontrol.ContentType[=string]

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (Wasabi Control)

The encryption algorithm.

Syntax

wasabicontrol.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 (Wasabi Control)

The encryption password.

Syntax

wasabicontrol.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 (Wasabi Control)

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

Syntax

wasabicontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (Wasabi Control)

This property determines the type of firewall to connect through.

Syntax

wasabicontrol.FirewallType[=integer]

Possible Values

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (Wasabi Control)

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

Syntax

wasabicontrol.FirewallHost[=string]

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (Wasabi Control)

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

Syntax

wasabicontrol.FirewallPassword[=string]

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (Wasabi Control)

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

Syntax

wasabicontrol.FirewallPort[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (Wasabi Control)

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

Syntax

wasabicontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

FollowRedirects Property (Wasabi Control)

Determines what happens when the server issues a redirect.

Syntax

wasabicontrol.FollowRedirects[=integer]

Possible Values

frNever(0), 
frAlways(1), 
frSameScheme(2)

Default Value

0

Remarks

This property specifies how the control should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:

Data Type

Integer

Idle Property (Wasabi Control)

The current status of the control.

Syntax

wasabicontrol.Idle

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (Wasabi Control)

The location of the local file.

Syntax

wasabicontrol.LocalFile[=string]

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Data Type

String

LocalHost Property (Wasabi Control)

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

Syntax

wasabicontrol.LocalHost[=string]

Default Value

""

Remarks

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

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

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 multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

MetadataCount Property (Wasabi Control)

The number of records in the Metadata arrays.

Syntax

wasabicontrol.MetadataCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (Wasabi Control)

The property contains the name of the metadata item.

Syntax

wasabicontrol.MetadataName(MetadataIndex)[=string]

Default Value

""

Remarks

The property contains the name of the metadata item.

This property specifies the name of the metadata item. The server stores metadata names in lowercase.

Note: The control will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.

The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (Wasabi Control)

This property contains the value of the metadata item.

Syntax

wasabicontrol.MetadataValue(MetadataIndex)[=string]

Default Value

""

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

ObjectComplianceConditionalHold Property (Wasabi Control)

Specifies whether an object is under conditional hold.

Syntax

wasabicontrol.ObjectComplianceConditionalHold[=string]

Default Value

""

Remarks

Specifies whether an object is under conditional hold.

An object under conditional hold cannot be deleted, but can be removed from conditional hold by setting this to "false" and calling UpdateCompliance for that object. Once an object is released from conditional hold, its retention period begins, and it cannot be deleted until its retention time has passed. An object cannot be restored to conditional hold.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

ObjectComplianceHash Property (Wasabi Control)

The SHA-256 hash of an object, intended to be used to verify that it hasn't changed.

Syntax

wasabicontrol.ObjectComplianceHash

Default Value

""

Remarks

The SHA-256 hash of an object, intended to be used to verify that it hasn't changed.

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

Data Type

String

ObjectComplianceLegalHold Property (Wasabi Control)

Specifies whether or not an object is under legal hold.

Syntax

wasabicontrol.ObjectComplianceLegalHold[=string]

Default Value

""

Remarks

Specifies whether or not an object is under legal hold.

If an object is under legal hold, it cannot be deleted regardless of whether or not its retention time has passed.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

ObjectComplianceRetentionTime Property (Wasabi Control)

The retention time for a specific object.

Syntax

wasabicontrol.ObjectComplianceRetentionTime[=string]

Default Value

""

Remarks

The retention time for a specific object.

An object's individual retention time is an ISO 8601 date-time before which the object cannot be deleted. The retention time of an object is initially set based on the value of RetentionDays setting of the bucket it resides in. Objects can have their retention time extended, but not reduced.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String

ObjectData Property (Wasabi Control)

The data that was downloaded, or that should be uploaded.

Syntax

wasabicontrol.ObjectData[=string]

Default Value

""

Remarks

This property is populated with object data after calling GetObject if LocalFile is not set.

This property can also be set before calling CreateObject or UploadPart; 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 .ObjectDataB.

This property is not available at design time.

Data Type

Binary String

ObjectDelimiter Property (Wasabi Control)

The delimiter string to use when listing objects.

Syntax

wasabicontrol.ObjectDelimiter[=string]

Default Value

""

Remarks

If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the control will also populate the PrefixCount and Prefix[i] configuration settings

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectMarker Property (Wasabi Control)

A marker indicating what page of objects to return next.

Syntax

wasabicontrol.ObjectMarker[=string]

Default Value

""

Remarks

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

Refer to ListObjects for more information.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (Wasabi Control)

A prefix used to restrict the results returned when listing objects.

Syntax

wasabicontrol.ObjectPrefix[=string]

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectsCount Property (Wasabi Control)

The number of records in the Objects arrays.

Syntax

wasabicontrol.ObjectsCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjectsDeleted
• ObjectsETag
• ObjectsLastModified
• ObjectsLatestVersion
• ObjectsName
• ObjectsOwnerDisplayName
• ObjectsOwnerId
• ObjectsSize
• ObjectsStorageClass
• ObjectsUploadId
• ObjectsVersionId

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

This property is not available at design time.

Data Type

Integer

ObjectsDeleted Property (Wasabi Control)

This property specifies whether this object version is a delete marker.

Syntax

wasabicontrol.ObjectsDeleted(ObjectsIndex)

Default Value

False

Remarks

This property specifies whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Boolean

ObjectsETag Property (Wasabi Control)

This property contains the ETag of the object.

Syntax

wasabicontrol.ObjectsETag(ObjectsIndex)

Default Value

""

Remarks

This property contains the ETag of the object.

This property reflects the ETag of the object.

An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsLastModified Property (Wasabi Control)

This property contains the last modified time of the object.

Syntax

wasabicontrol.ObjectsLastModified(ObjectsIndex)

Default Value

""

Remarks

This property contains the last modified time of the object.

This property reflects the last modified time of the object.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsLatestVersion Property (Wasabi Control)

This property specifies whether this is the latest object version.

Syntax

wasabicontrol.ObjectsLatestVersion(ObjectsIndex)

Default Value

True

Remarks

This property specifies whether this is the latest object version.

This property indicates whether this object version is the latest version available.

This is applicable only when ListVersions is called.; in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Boolean

ObjectsName Property (Wasabi Control)

This property contains the name (key) of the object.

Syntax

wasabicontrol.ObjectsName(ObjectsIndex)

Default Value

""

Remarks

This property contains the name (key) of the object.

This property reflects the name (key) of the object.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsOwnerDisplayName Property (Wasabi Control)

This property contains the display name of the object's owner.

Syntax

wasabicontrol.ObjectsOwnerDisplayName(ObjectsIndex)

Default Value

""

Remarks

This property contains the display name of the object's owner.

This property reflects the display name of the object's owner.

This is not applicable when GetObjectInfo is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsOwnerId Property (Wasabi Control)

This property contains the Id of the object's owner.

Syntax

wasabicontrol.ObjectsOwnerId(ObjectsIndex)

Default Value

""

Remarks

This property contains the Id of the object's owner.

This property reflects the Id of the object's owner.

This is not applicable when GetObjectInfo is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsSize Property (Wasabi Control)

This property contains the size of the object.

Syntax

wasabicontrol.ObjectsSize(ObjectsIndex)

Default Value

0

Remarks

This property contains the size of the object.

This property reflects the size of the object in bytes.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Long64

ObjectsStorageClass Property (Wasabi Control)

This property contains the storage class of the object.

Syntax

wasabicontrol.ObjectsStorageClass(ObjectsIndex)

Default Value

""

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsUploadId Property (Wasabi Control)

This property contains the upload Id of the multipart upload.

Syntax

wasabicontrol.ObjectsUploadId(ObjectsIndex)

Default Value

""

Remarks

This property contains the upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

It is applicable only when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsVersionId Property (Wasabi Control)

This property contains the Id of the object version.

Syntax

wasabicontrol.ObjectsVersionId(ObjectsIndex)

Default Value

""

Remarks

This property contains the Id of the object version.

This property reflects the Id of the object version.

Note: The string null is a valid version Id.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

OtherHeaders Property (Wasabi Control)

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

Syntax

wasabicontrol.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 (Wasabi Control)

Determines if local files are overwritten.

Syntax

wasabicontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is .

Data Type

Boolean

ParsedHeaderCount Property (Wasabi Control)

The number of records in the ParsedHeader arrays.

Syntax

wasabicontrol.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 (Wasabi Control)

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

Syntax

wasabicontrol.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 (Wasabi Control)

This property contains the header contents.

Syntax

wasabicontrol.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

PartMarker Property (Wasabi Control)

A marker indicating what page of parts to return next.

Syntax

wasabicontrol.PartMarker[=string]

Default Value

""

Remarks

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

Refer to ListParts for more information.

This property is not available at design time.

Data Type

String

PartsCount Property (Wasabi Control)

The number of records in the Parts arrays.

Syntax

wasabicontrol.PartsCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartsETag
• PartsLastModified
• PartsNumber
• PartsObjectName
• PartsOwnerDisplayName
• PartsOwnerId
• PartsSize

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

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

Data Type

Integer

PartsETag Property (Wasabi Control)

This property contains the ETag of the part.

Syntax

wasabicontrol.PartsETag(PartsIndex)

Default Value

""

Remarks

This property contains the ETag of the part.

This property reflects the ETag of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsLastModified Property (Wasabi Control)

This property contains the last modified time of the part.

Syntax

wasabicontrol.PartsLastModified(PartsIndex)

Default Value

""

Remarks

This property contains the last modified time of the part.

This property reflects the last modified time of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsObjectName Property (Wasabi Control)

This property contains the name (key) of the object that the part was uploaded for.

Syntax

wasabicontrol.PartsObjectName(PartsIndex)

Default Value

""

Remarks

This property contains the name (key) of the object that the part was uploaded for.

This property reflects the name (key) of the object that the part was uploaded for.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsOwnerDisplayName Property (Wasabi Control)

This property contains the display name of the part's owner.

Syntax

wasabicontrol.PartsOwnerDisplayName(PartsIndex)

Default Value

""

Remarks

This property contains the display name of the part's owner.

This property reflects the display name of the part's owner.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsOwnerId Property (Wasabi Control)

This property contains the Id of the part's owner.

Syntax

wasabicontrol.PartsOwnerId(PartsIndex)

Default Value

""

Remarks

This property contains the Id of the part's owner.

This property reflects the Id of the part's owner.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsNumber Property (Wasabi Control)

This property contains the number of the part.

Syntax

wasabicontrol.PartsNumber(PartsIndex)

Default Value

0

Remarks

This property contains the number of the part.

This property reflects the number of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

Integer

PartsSize Property (Wasabi Control)

This property contains the size of the part.

Syntax

wasabicontrol.PartsSize(PartsIndex)

Default Value

0

Remarks

This property contains the size of the part.

This property reflects the size of the part in bytes.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

Long64

ProxyAuthScheme Property (Wasabi Control)

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

Syntax

wasabicontrol.ProxyAuthScheme[=integer]

Possible Values

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

Default Value

0

Remarks

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

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

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

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

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the 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 (Wasabi Control)

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

Syntax

wasabicontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (Wasabi Control)

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

Syntax

wasabicontrol.ProxyPassword[=string]

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (Wasabi Control)

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

Syntax

wasabicontrol.ProxyPort[=integer]

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (Wasabi Control)

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

Syntax

wasabicontrol.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 (Wasabi Control)

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

Syntax

wasabicontrol.ProxySSL[=integer]

Possible Values

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (Wasabi Control)

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

Syntax

wasabicontrol.ProxyUser[=string]

Default Value

""

Remarks

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

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

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

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

Data Type

String

QueryParamCount Property (Wasabi Control)

The number of records in the QueryParam arrays.

Syntax

wasabicontrol.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 (Wasabi Control)

The name of the query parameter.

Syntax

wasabicontrol.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 (Wasabi Control)

The value of the query parameter.

Syntax

wasabicontrol.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

Range Property (Wasabi Control)

The range of bytes to request.

Syntax

wasabicontrol.Range[=string]

Default Value

""

Remarks

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

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

• StartByte-
• StartByte-EndByte

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

This property is not available at design time.

Data Type

String

Region Property (Wasabi Control)

The region the control will make requests against.

Syntax

wasabicontrol.Region[=string]

Default Value

"us-east-1"

Remarks

This property control which region the control will make requests against. By default the control uses us-east-1, the US East (Ashburn, VA) region. This property should be changed to create or access resources in other regions.

Regions:

The control will always convert this property's value to lowercase. If this property is cleared, the control will reset it to the default value.

Data Type

String

SecretKey Property (Wasabi Control)

The secret key to use for authentication.

Syntax

wasabicontrol.SecretKey[=string]

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCertEncoded Property (Wasabi Control)

This is the certificate (PEM/Base64 encoded).

Syntax

wasabicontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

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

SSLCertEncoded Property (Wasabi Control)

This is the certificate (PEM/Base64 encoded).

Syntax

wasabicontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

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

SSLCertStore Property (Wasabi Control)

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

Syntax

wasabicontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

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

Data Type

Binary String

SSLCertStorePassword Property (Wasabi 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

wasabicontrol.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 (Wasabi Control)

This is the type of certificate store for this certificate.

Syntax

wasabicontrol.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

This is 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

SSLCertSubject Property (Wasabi Control)

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

Syntax

wasabicontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (Wasabi Control)

This specifies the SSL/TLS implementation to use.

Syntax

wasabicontrol.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:

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

SSLServerCertEncoded Property (Wasabi Control)

This is the certificate (PEM/Base64 encoded).

Syntax

wasabicontrol.SSLServerCertEncoded

Default Value

""

Remarks

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

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

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

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

Syntax

wasabicontrol.StartByte[=long64]

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (Wasabi Control)

A timeout for the control.

Syntax

wasabicontrol.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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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

UseSSL Property (Wasabi Control)

Whether to use SSL/TLS when connecting.

Syntax

wasabicontrol.UseSSL[=boolean]

Default Value

True

Remarks

This property specifies whether the control should use SSL/TLS when connecting.

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (Wasabi Control)

Determines which style request to use.

Syntax

wasabicontrol.UseVirtualHosting[=boolean]

Default Value

True

Remarks

If set to (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.wasabisys.com/yourobject. If , the control will use the path-style request: http://s3.wasabisys.com/yourbucket/yourobject.

NOTE: When set to , there are more limitations when choosing a bucket name due to DNS server naming restrictions. Wasabi follows Amazon's naming restrictions, so refer to Amazon's S3 documentation for more information.

This property is not available at design time.

Data Type

Boolean

VersionId Property (Wasabi Control)

The object version to make requests against.

Syntax

wasabicontrol.VersionId[=string]

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

Data Type

String

VersioningEnabled Property (Wasabi Control)

Controls whether versioning is enabled for the currently selected bucket.

Syntax

wasabicontrol.VersioningEnabled[=boolean]

Default Value

False

Remarks

This property can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this property will always return when queried, and any attempts to set it will fail.

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

Data Type

Boolean

VersionMarker Property (Wasabi Control)

A marker indicating what page of object versions to return next.

Syntax

wasabicontrol.VersionMarker[=string]

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (Wasabi Control)

Aborts a multipart upload.

Syntax

wasabicontrol.AbortMultipartUpload ObjectName, UploadId

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)

If this method is called successfully, the specified UploadId will no longer be valid.

AddMetadata Method (Wasabi Control)

Adds a metadata item to the Metadata properties.

Syntax

wasabicontrol.AddMetadata Name, Value

Remarks

This method adds a metadata item to the Metadata* properties. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The control will take care of prepending it when sending metadata to the server.

AddQueryParam Method (Wasabi Control)

Adds a query parameter to the QueryParams properties.

Syntax

wasabicontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryaParam* 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.

AppendObject Method (Wasabi Control)

Appends data onto an object on the server.

Syntax

wasabicontrol.AppendObject ObjectName

Remarks

This method will append the content of the file specified by LocalFile into the bucket specified by the Bucket property. If LocalFile is empty, the contents of the ObjectData property will be uploaded instead.

You may only append to an object that already exists. To create a new object, use the CreateObject method.

Note: Appending is a form of object composition, so the same restrictions that apply for object composition also apply when appending to objects; refer to ComposeObjects for more information.

BucketExists Method (Wasabi Control)

Checks whether the bucket exists.

Syntax

wasabicontrol.BucketExists 

Remarks

This method checks whether the bucket specified by Bucket exists, returning if so or if not.

CheckVersioningEnabled Method (Wasabi Control)

Checks whether versioning is enabled for the currently selected bucket.

Syntax

wasabicontrol.CheckVersioningEnabled 

Remarks

This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return when queried.

Refer to Amazon's Versioning documentation for more information about versioning.

CompleteMultipartUpload Method (Wasabi Control)

Completes a multipart upload by assembling previously uploaded parts.

Syntax

wasabicontrol.CompleteMultipartUpload ObjectName, UploadId

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts* properties, nor does it cause the PartList event to fire.

ComposeObjects Method (Wasabi Control)

Creates a composed object using multiple objects already on the server.

Syntax

wasabicontrol.ComposeObjects ComposedObjectName

Remarks

This method is used to compose objects on the server. Object composition is a server-side method of building an object by concatenating multiple existing objects together. This feature is a simpler alternative to the typical multipart-upload method of building objects.

A composed object looks and acts just like a regular object. However, its data is determined by its component objects (that is, the objects that make it up) and the order in which they are composed together.

To use this method, specify the names of the objects that should be composed together using the Objects property. When this method is called, the ComposedObjectName parameter determines what name is given to the resulting composed object. See the following code snippet for examples: // Upload some objects to start with. Let's assume we have some text files to upload. for (int i = 1; i <= 3; i++) { wasabi.LocalFile = "file" + i + ".txt"; wasabi.CreateObject("file" + i + ".txt"); } // Compose a new object. SetObjectNames("file1.txt", "file2.txt", "file3.txt"); wasabi.ComposeObjects("composed1.txt"); // Compose a new object using a composed object. SetObjectNames("file1.txt", "composed1.txt"); wasabi.ComposeObjects("composed2.txt"); // Compose onto an existing composed object. // (Similar to appending, but all server-side, no uploading needed.) SetObjectNames("file1.txt", "file2.txt"); wasabi.ComposeObjects("composed3.txt"); SetObjectNames("composed3.txt", "file3.txt"); wasabi.ComposeObjects("composed3.txt"); // Compose a new object using the same object twice. SetObjectNames("file1.txt", "file1.txt"); wasabi.ComposeObjects("composed4.txt"); // Compose a composed object onto itself. SetObjectNames("composed4.txt", "composed4.txt"); wasabi.ComposeObjects("composed4.txt"); Assume we have this helper method for the above code: void SetObjectNames(params string[] names) { wasabi.Objects.Clear(); foreach (string name in names) wasabi.Objects.Add(new S3Object(name, "", 0, "", "", "", "", "")); }

Object composition is a powerful and flexible feature. However, there are some things to keep in mind when doing object composition:

• The order of the object names in the Objects property is the order that they will be concatenated in when they are composed.
• Objects from multiple buckets cannot be composed together.
• No more than 32 object names may be specified in a single compose request.
• No more than 1024 original objects may be composed together. This is a transitive limit, it cannot be circumvented by composing together composed objects.

Wasabi does not make copies of data when composing objects, it uses references, so there are no extra data charges. Even if the original objects are deleted, a single copy of the data is kept until there are no longer any composed objects which reference it. Refer to the Wasabi documentation for more information.

Config Method (Wasabi Control)

Sets or retrieves a configuration setting.

Syntax

wasabicontrol.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.

CopyObject Method (Wasabi Control)

Copies an object.

Syntax

wasabicontrol.CopyObject SrcObjectName, DestBucket, DestObjectName

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.

If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If there are any metadata items present in the Metadata* properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may only be copied to buckets that exist within the same region.
• Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.

CopyPart Method (Wasabi Control)

Copies the specified object as a part of a multipart upload.

Syntax

wasabicontrol.CopyPart SrcObjectName, DestBucket, DestObjectName, DestPartNumber, DestUploadId

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

CreateBucket Method (Wasabi Control)

Creates a new bucket.

Syntax

wasabicontrol.CreateBucket 

Remarks

This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.

CreateObject Method (Wasabi Control)

Creates a new object in the currently selected bucket.

Syntax

wasabicontrol.CreateObject ObjectName

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata* properties, they will included in the creation request.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

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

This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the control will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the control automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.

DeleteBucket Method (Wasabi Control)

Deletes a bucket.

Syntax

wasabicontrol.DeleteBucket 

Remarks

This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.

DeleteObject Method (Wasabi Control)

Deletes an object.

Syntax

wasabicontrol.DeleteObject ObjectName

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.

If the VersionId property is non-empty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

DisableVersioning Method (Wasabi Control)

Disables versioning for the currently selected bucket.

Syntax

wasabicontrol.DisableVersioning 

Remarks

This method can be used to disable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

DoEvents Method (Wasabi Control)

Processes events from the internal message queue.

Syntax

wasabicontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

EnableVersioning Method (Wasabi Control)

Enables versioning for the currently selected bucket.

Syntax

wasabicontrol.EnableVersioning 

Remarks

This method can be used to enable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

GetBucketLocation Method (Wasabi Control)

Gets a bucket's location.

Syntax

wasabicontrol.GetBucketLocation 

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.

GetCompliance Method (Wasabi Control)

Gets the compliance settings for the current bucket or an object in it.

Syntax

wasabicontrol.GetCompliance ObjectName

Remarks

Calling this method and passing the empty string for ObjectName will cause BucketCompliance to be populated for the current bucket. Otherwise, this method will cause ObjectCompliance to be populated for the object with the given ObjectName (as long as such an object exists in the current bucket, and the bucket's compliance settings are enabled).

Refer to the UpdateCompliance documentation for more information about compliance.

GetLink Method (Wasabi Control)

Creates a link that provides access to an object for a specified amount of time.

Syntax

wasabicontrol.GetLink ObjectName, Expires

Remarks

This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.

GetObject Method (Wasabi Control)

Downloads an object.

Syntax

wasabicontrol.GetObject ObjectName

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.

If LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

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

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Resuming Downloads

The control also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the control creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

GetObjectInfo Method (Wasabi Control)

Gets an object's information and metadata.

Syntax

wasabicontrol.GetObjectInfo ObjectName

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects* and Metadata* properties.

Interrupt Method (Wasabi Control)

Interrupt the current method.

Syntax

wasabicontrol.Interrupt 

Remarks

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

ListBuckets Method (Wasabi Control)

Lists all buckets in the account.

Syntax

wasabicontrol.ListBuckets 

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets* properties.

ListMultipartUploads Method (Wasabi Control)

Lists the current multipart uploads.

Syntax

wasabicontrol.ListMultipartUploads 

Remarks

This method lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects* properties.

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

ListObjects Method (Wasabi Control)

Lists the objects in a bucket.

Syntax

wasabicontrol.ListObjects 

Remarks

This method lists the objects in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object, and will also populate the Objects* properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ListParts Method (Wasabi Control)

Lists the parts in a multipart upload.

Syntax

wasabicontrol.ListParts ObjectName, UploadId

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

Calling this method will fire the PartList event once for each part, and will also populate the Parts* properties.

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts* properties.

Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the control will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.

ListVersions Method (Wasabi Control)

Lists the object versions in a bucket.

Syntax

wasabicontrol.ListVersions 

Remarks

This method lists the object versions in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects* properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

RenameBucket Method (Wasabi Control)

Renames a bucket.

Syntax

wasabicontrol.RenameBucket BucketName, NewName

Remarks

This method renames the bucket named BucketName to the name NewName. NewName cannot already be in use by another bucket.

RenameFolder Method (Wasabi Control)

Renames a folder.

Syntax

wasabicontrol.RenameFolder FolderName, NewName

Remarks

This method renames the folder named FolderName to the name NewName. If NewName is already in use by existing folders, it will be overwritten if the current bucket has versioning enabled, or if the OverwriteOnRename configuration setting is set to (default).

Since "folders" are in fact just name prefixes formatted to mimic a traditional file system, this method can rename multiple levels of "folders" at once by renaming a prefix. For example, assume you have the following objects in a bucket:

• /pictures/animals/cats/cat1.jpg
• /pictures/animals/cats/cat2.jpg
• /pictures/animals/cats/cat3.jpg
• /pictures/animals/cats/cat4.jpg
• /pictures/animals/dogs/dog4.jpg
• /pictures/animals/dogs/dog5.jpg

Doing the following command would leave you with the following objects in the bucket:

wasabi.RenameFolder("/pictures/animals/cats/", "pictures/pets/dogs");

• /pictures/pets/dogs/cat1.jpg
• /pictures/pets/dogs/cat2.jpg
• /pictures/pets/dogs/cat3.jpg
• /pictures/pets/dogs/cat4.jpg
• /pictures/pets/dogs/dog4.jpg
• /pictures/pets/dogs/dog5.jpg

And doing this command instead would leave you with these objects in the bucket, since the prefix being renamed now includes part of the "filename", and since (by default) the original "dog4.jpg" will get overwritten when "cat4.jpg" is renamed:

wasabi.RenameFolder("/pictures/animals/cats/cat", "pictures/pets/dogs/dog");

• /pictures/pets/dogs/dog1.jpg
• /pictures/pets/dogs/dog2.jpg
• /pictures/pets/dogs/dog3.jpg
• /pictures/pets/dogs/dog4.jpg
• /pictures/pets/dogs/dog5.jpg

RenameObject Method (Wasabi Control)

Renames an object.

Syntax

wasabicontrol.RenameObject ObjectName, NewName

Remarks

This method renames the object named ObjectName to the name NewName. If NewName is already in use by an existing object, it will be overwritten if the current bucket has versioning enabled, or if the OverwriteOnRename configuration setting is set to (default).

Reset Method (Wasabi Control)

Resets the control to its initial state.

Syntax

wasabicontrol.Reset 

Remarks

This method resets the control to its initial state.

ResetHeaders Method (Wasabi Control)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

wasabicontrol.ResetHeaders 

Remarks

Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata* and QueryParam* properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

SendCustomRequest Method (Wasabi Control)

Sends a custom request to the server.

Syntax

wasabicontrol.SendCustomRequest HttpMethod, ObjectName, RequestBody

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

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

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the control does the following:

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
   • Bucket (if non-empty)
   • ObjectName (if non-empty)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParam*
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • ProductToken
   • SessionToken
   • UserToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).

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

StartMultipartUpload Method (Wasabi Control)

Starts a new manual multipart upload.

Syntax

wasabicontrol.StartMultipartUpload ObjectName

Remarks

This method starts a new "manual" multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the CreateObject method. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If there are any metadata items present in the Metadata* properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

UpdateBucketACL Method (Wasabi Control)

Updates a bucket's canned access policy.

Syntax

wasabicontrol.UpdateBucketACL 

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

UpdateCompliance Method (Wasabi Control)

Updates the compliance settings for the current bucket or an object in it.

Syntax

wasabicontrol.UpdateCompliance ObjectName

Remarks

Calling this method and passing the empty string for ObjectName will cause the compliance settings stored in BucketCompliance to be applied to the current bucket. Otherwise, this method will cause the compliance settings stored in ObjectCompliance to be applied to the object with the given ObjectName (as long as such an object exists in the current bucket, and the bucket's compliance settings are enabled).

Compliance Notes

Compliance is a Wasabi feature that prevents objects from being modified or deleted before a specified time. The following tables and examples show what compliance settings are available at the bucket- and object-levels, what they do, and how they are used. Be sure to review the documentation for each of the individual settings for more information about them.

Bucket Compliance Settings

Compliance starts at the bucket level, it must be turned on for a bucket in order for the objects within that bucket to be under compliance. The control makes this easy to do: wasabi.Bucket = "MyBucket"; wasabi.BucketCompliance = new WasabiBucketCompliance("enabled", "", 10, "true", ""); wasabi.UpdateCompliance(""); This code turns on compliance settings for the bucket called "MyBucket", setting them so that objects are placed under conditional hold, and must be retained for 10 days after the conditional hold is released. The LockTime and DeleteAfterRetention settings are left alone, so they will default to "off" and "false" (respectively).

Important: Locking the compliance settings on a bucket using the LockTime setting is a one-way action. You cannot unlock a bucket's compliance settings without contacting the Wasabi support team. Refer to the Wasabi documentation for more information.

Object Compliance Settings

When an object's bucket has compliance enabled, all objects in that bucket are under compliance, and you can query any object's compliance settings using the GetCompliance method.

Any individual object can have its compliance settings updated as well. The LegalHold setting can be toggled to prevent (or allow) deletion; the object's ConditionalHold, if "true", can be released by setting to "false", at which time the object will begin its retention period. The object's RetentionTime can also be extended (but not reduced). For example, if you wanted to release an object from conditional hold: wasabi.Bucket = "MyBucket"; wasabi.ObjectCompliance = new WasabiObjectCompliance("", "false", ""); wasabi.UpdateCompliance("MyObject");

Further Information

Compliance is a powerful tool, but it must be handled carefully. These notes, and the documentation for the compliance-related properties, methods, and types, do not supersede Wasabi's documentation, and reviewing that documentation is highly recommended to gain a full understanding of how compliance works.

UpdateObjectACL Method (Wasabi Control)

Updates an object's canned access policy.

Syntax

wasabicontrol.UpdateObjectACL ObjectName

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.

UploadPart Method (Wasabi Control)

Uploads a multipart upload part.

Syntax

wasabicontrol.UploadPart ObjectName, PartNumber, UploadId

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.

The data to upload is taken from either LocalFile or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is , the control will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.

BucketList Event (Wasabi Control)

Fires once for each bucket returned when listing buckets.

Syntax

Sub wasabicontrol_BucketList(BucketName As String, CreationDate As String, OwnerId As String, OwnerName As String)

Remarks

This event fires once for each bucket returned when ListBuckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

EndTransfer Event (Wasabi Control)

This event fires when a document finishes transferring.

Syntax

Sub wasabicontrol_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 (Wasabi Control)

Fired when information is available about errors during data delivery.

Syntax

Sub wasabicontrol_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 (Wasabi Control)

Fires after each part in an automatic multipart upload is complete.

Syntax

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

Remarks

If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the control will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

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

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

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

Refer to CreateObject for more information.

Header Event (Wasabi Control)

This event is fired every time a header line comes in.

Syntax

Sub wasabicontrol_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).

Log Event (Wasabi Control)

This event fires once for each log message.

Syntax

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

Remarks

This event fires 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"

MetadataList Event (Wasabi Control)

Fires once for each metadata item returned when object information and metadata is retrieved.

Syntax

Sub wasabicontrol_MetadataList(Name As String, Value As String)

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (Wasabi Control)

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

Sub wasabicontrol_ObjectList(BucketName As String, ObjectName As String, LastModified As String, Size As Long64, ETag As String, OwnerId As String, OwnerName As String, UploadId As String, VersionId As String, LatestVersion As Boolean, Deleted As Boolean)

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; in all other cases.

PartList Event (Wasabi Control)

Fires once for every part returned when listing a multipart upload's parts.

Syntax

Sub wasabicontrol_PartList(PartNumber As Integer, ObjectName As String, LastModified As String, Size As Long64, ETag As String, OwnerId As String, OwnerName As String)

Remarks

This event fires once for each multipart upload part returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

PrefixList Event (Wasabi Control)

Fires once for each common prefix returned when listing objects.

Syntax

Sub wasabicontrol_PrefixList(BucketName As String, Prefix As String)

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (Wasabi Control)

Fires during an upload or download to indicate transfer progress.

Syntax

Sub wasabicontrol_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 (Wasabi Control)

Fired after the server presents its certificate to the client.

Syntax

Sub wasabicontrol_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 (Wasabi Control)

Fired when secure connection progress messages are available.

Syntax

Sub wasabicontrol_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 (Wasabi Control)

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

Syntax

Sub wasabicontrol_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 (Wasabi Control)

This event is fired while a document transfers (delivers document).

Syntax

Sub wasabicontrol_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.

Config Settings (Wasabi Control)

Wasabi 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"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (Wasabi Control)

Common Errors

Wasabi Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors