ListContainers Method

Lists the containers in the blob storage account.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListContainers();

Unicode (Windows)
INT ListContainers();

- (void)listContainers;

#define MID_AZUREBLOB_LISTCONTAINERS 25

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

Remarks

This method lists the containers in the Azure blob storage account specified by the Account property.

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

Calling this method will fire the ContainerList event once for each container, and will also populate the Container* properties. It may also fire the MetadataList event, depending on how the ListWithMetadata setting is configured.

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

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