DeleteKey Method
Deletes the specified key.
Syntax
ANSI (Cross Platform) int DeleteKey(const char* lpszUserId); Unicode (Windows) INT DeleteKey(LPCWSTR lpszUserId);
- (void)deleteKey:(NSString*)userId;
#define MID_KEYMGR_DELETEKEY 9 IPWORKSENCRYPT_EXTERNAL int IPWORKSENCRYPT_CALL IPWorksEncrypt_KeyMgr_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method deletes the key specified by UserId from the current keyring. Below is a table of the type of Ids that may be specified to identify the key:
Id Type | Example |
UserId | FirstName LastName <user@mail.com> |
UserId (name only) | FirstName LastName |
UserId (first name only) | FirstName |
UserId (email only) | user@mail.com |
Short KeyId | 89C9D7B1 |
Long KeyId | F7B7D49C89C9D7B1 |
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.)