LeaseId Property

The lease Id to include when making requests.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetLeaseId();
int SetLeaseId(const char* lpszLeaseId);

Unicode (Windows)
LPWSTR GetLeaseId();
INT SetLeaseId(LPCWSTR lpszLeaseId);

@property (nonatomic,readwrite,assign,getter=leaseId,setter=setLeaseId:) NSString* leaseId;
- (NSString*)leaseId;
- (void)setLeaseId:(NSString*)newLeaseId;

#define PID_AZUREBLOB_LEASEID 55

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

Default Value

""

Remarks

This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.

For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For CreateBlob and CopyBlob, note that this property must be empty if the target blob does not yet exist.

For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.

Finally, note that this property is used in a specific manner by the Lease method; refer to its documentation for more information.

This property is not available at design time.

Data Type

String