IPWorks Encrypt 2020 C++ Edition

Questions / Feedback?

ImportKey Method

Imports the key specified by UserId to the current keyring.

Syntax

ANSI (Cross Platform)
int ImportKey(const char* lpszFileName, const char* lpszUserId);

Unicode (Windows)
INT ImportKey(LPCWSTR lpszFileName, LPCWSTR lpszUserId);
- (void)importKey:(NSString*)fileName :(NSString*)userId;
#define MID_KEYMGR_IMPORTKEY 12

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

Remarks

This method imports the key specified by UserId from the key file specified by FileName into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the FileName specifies a key file which contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key file will be imported. The ImportAllKeys setting controls the behavior of the class in this case.

Note: If you simply wish to select a key in the current ring set KeyUserId instead.

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 C++ Edition - Version 20.0 [Build 8155]