GetSecret Method

Gets a secret's value and information.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetSecret(const char* lpszSecretName);

Unicode (Windows)
INT GetSecret(LPCWSTR lpszSecretName);

- (void)getSecret:(NSString*)secretName;

#define MID_AZURESECRETS_GETSECRET 9

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

Remarks

This method gets the value and information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version. The secret's value is returned via the output stream supplied via the SetOutputStream method, the specified LocalFile, or the SecretData property.

Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted secret's information (but not its value).

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and repopulates the Tag* properties with the secret's tags. The SecretList and TagList events are also fired.

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