DestroyVersion Method

Schedules the specified key version's cryptographic material for destruction.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int DestroyVersion(const char* lpszKeyName, const char* lpszVersionId);

Unicode (Windows)
INT DestroyVersion(LPCWSTR lpszKeyName, LPCWSTR lpszVersionId);

- (void)destroyVersion:(NSString*)keyName :(NSString*)versionId;

#define MID_GOOGLEKMS_DESTROYVERSION 10

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

Remarks

This method schedules the destruction of the cryptographic material for the key version specified by KeyName and VersionId. The key version itself is not deleted, just its cryptographic material.

If this method is successful, the key version's VersionState changes to DESTROY_SCHEDULED, and the its cryptographic material will be destroyed after 24 hours. During this waiting period, the destruction can be canceled using the CancelDestruction method.

Important: Destroying a key version's cryptographic material makes the key version permanently unusable. If a key version must not be used by may be needed again in the future, disable using SetVersionEnabled instead.

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