ListVersions Method

Lists versions of a key.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListVersions(const char* lpszKeyName);

Unicode (Windows)
INT ListVersions(LPCWSTR lpszKeyName);

- (void)listVersions:(NSString*)keyName;

#define MID_AZUREKEYS_LISTVERSIONS 13

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AzureKeys_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method lists the versions of the key specified by KeyName.

Calling this method will fire the KeyList event once for each key version, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for key versions when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key version; refer to its documentation for more information.

• KeyOps
• KeyType
• KeyPublicKey

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

The MaxKeys configuration setting can be used to control the maximum number of results to return at once.

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