ListKeyRings Method

Lists the key rings in the currently-selected location.

Syntax

ANSI (Cross Platform)
int ListKeyRings();

Unicode (Windows)
INT ListKeyRings();
- (void)listKeyRings;
#define MID_GOOGLEKMS_LISTKEYRINGS 17

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

Remarks

This method lists the key rings in the currently-selected Location.

Calling this method will fire the KeyRingList event once for each key ring, and will also populate the KeyRing* properties.

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

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

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]