BackupKey Method

Backs up a key.

Syntax

• C++
• Objective-C
• C

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

Unicode (Windows)
INT BackupKey(LPCWSTR lpszKeyName);

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

#define MID_AZUREKEYS_BACKUPKEY 4

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

Remarks

This method backs up the key specified by KeyName, returning it in a protected form via the output stream specified via the SetOutputStream method, the specified OutputFile, or the OutputData property.

Note that the protected key cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreKey method in order to be used.

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