IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

AddMetadata Method

Adds a metadata item to the Metadata properties.

Syntax

ANSI (Cross Platform)
int AddMetadata(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddMetadata(LPCWSTR lpszName, LPCWSTR lpszValue);
- (void)addMetadata:(NSString*)name :(NSString*)value;
#define MID_BACKBLAZEB2_ADDMETADATA 3

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

Remarks

This method adds a metadata item with the given Name and Value to the Metadata* properties. Name may be up to 50 characters in length, and must consist solely of letters, numbers, hyphens (-), and underscores (_). The server stores all metadata item names in lowercase.

A metadata item's name cannot start with b2- unless said name is one those explicitly defined by the Backblaze B2 API documentation. Keep in mind that the value of such a metadata item must comply with the format specified by the Backblaze B2 API documentation as well, otherwise the server will reject it.

Note that there is a limit of 10 metadata items per bucket and per file; the class does not enforce this limit, but the server will return an error if it is exceeded. For files specifically, any value set using the ClientModifiedTime configuration setting will count towards this limit; refer that setting's documentation 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]