IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

UpdateBucket Method

Updates a bucket's kind and/or metadata.

Syntax

ANSI (Cross Platform)
int UpdateBucket(const char* lpszBucketId, const char* lpszNewKind, int bNewMetadata);

Unicode (Windows)
INT UpdateBucket(LPCWSTR lpszBucketId, LPCWSTR lpszNewKind, BOOL bNewMetadata);
- (void)updateBucket:(NSString*)bucketId :(NSString*)newKind :(BOOL)newMetadata;
#define MID_BACKBLAZEB2_UPDATEBUCKET 34

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

Remarks

This method updates the kind and/or metadata of the bucket specified by BucketId.

If NewKind is non-empty, it must be allPrivate or allPublic. If NewKind is empty, the bucket's kind remains unchanged.

If NewMetadata is true, the bucket's current metadata items are replaced with those in the Metadata* properties (or cleared, if said properties are empty). If NewMetadata is false, the bucket's current metadata remains unchanged. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

If NewKind is empty and NewMetadata is false, this method does nothing.

The IfRevision setting can optionally be set before calling this method to ensure that the requested changes are only made if the bucket's current revision matches the given one.

The currently-authenticated application key must have the writeBuckets 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.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 C++ Edition - Version 20.0 [Build 8265]