DeleteBucket Method

Deletes a bucket.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int DeleteBucket(const char* lpszBucketId);

Unicode (Windows)
INT DeleteBucket(LPCWSTR lpszBucketId);

- (void)deleteBucket:(NSString*)bucketId;

#define MID_BACKBLAZEB2_DELETEBUCKET 13

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_BackblazeB2_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method deletes the bucket specified by BucketId. A bucket must be completely empty to be deleted.

Note that bucket names are global, and it may not be possible to recreate a deleted bucket if its name is taken by another user in the meantime.

The currently-authenticated application key must have the deleteBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)