ListKeys Method

Lists CMKs in the current account and region.

Syntax

int ListKeys();

Remarks

This method lists the CMKs in the current account and Region.

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

If there are still more CMKs available to list when this method returns, the KeyMarker property will be populated. Continue to call this method until KeyMarker 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

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.
Cloud Keys 2020 Qt Edition - Version 20.0 [Build 8157]