LoadKeyring Method

Loads the keyring from disk.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int LoadKeyring(const char* lpszKeyringPath);

Unicode (Windows)
INT LoadKeyring(LPCWSTR lpszKeyringPath);

- (void)loadKeyring:(NSString*)keyringPath;

#define MID_KEYMGR_LOADKEYRING 17

IPWORKSENCRYPT_EXTERNAL int IPWORKSENCRYPT_CALL IPWorksEncrypt_KeyMgr_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method loads the keyring from disk. If the keyring is stored in a directory, set KeyringPath to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file KeyringPath should be set to the path of the file.

When this method is called the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

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