IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

ListJobs Method

Lists the jobs in a vault.

Syntax

ANSI (Cross Platform)
int ListJobs(const char* lpszVaultName);

Unicode (Windows)
INT ListJobs(LPCWSTR lpszVaultName);
- (void)listJobs:(NSString*)vaultName;
#define MID_AMAZONGLACIER_LISTJOBS 16

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

Remarks

This method lists the jobs in the vault specified by VaultName.

The JobList event will fire once for each Job returned. In addition, the Job* properties will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to true and JobMarker will be populated.

To get all results simply call ListJobs again until IsJobPaged returns False and JobMarker is empty string.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are returned.

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]