DeleteKey Method

Deletes a key.

Syntax

• C++
• Objective-C
• C

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

Unicode (Windows)
INT DeleteKey(LPCWSTR lpszKeyName);

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

#define MID_AZUREKEYS_DELETEKEY 8

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

Remarks

This method deletes the key specified by KeyName. If there are multiple versions of the key, all of them are deleted.

Note that the key is only soft-deleted; it can be recovered during the retention period using the RecoverKey method, or permanently deleted using the PurgeKey method. The length of the retention period depends on the configuration of the currently-selected Vault, refer to the Azure Key Vault documentation for more information.

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