UserManager Class

Properties   Methods   Events   Config Settings   Errors  

The UserManager class stores information about user accounts.

Syntax

UserManager

Remarks

UserManager is responsible for storing, importing, and exporting information about users. It is primarily used with the server components.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

FIPSMode Property (UserManager Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_usermanager_getfipsmode(void* lpObj);
int secureblackbox_usermanager_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

UserCount Property (UserManager Class)

The number of records in the User arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCount();
int SetUserCount(int iUserCount);

Unicode (Windows)
INT GetUserCount();
INT SetUserCount(INT iUserCount);

int secureblackbox_usermanager_getusercount(void* lpObj);
int secureblackbox_usermanager_setusercount(void* lpObj, int iUserCount);

int GetUserCount();
int SetUserCount(int iUserCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserAssociatedData
• UserBasePath
• UserCert
• UserData
• UserHandle
• UserHashAlgorithm
• UserIncomingSpeedLimit
• UserOtpAlgorithm
• UserOtpValue
• UserOutgoingSpeedLimit
• UserPassword
• UserPasswordLen
• UserSharedSecret
• UserSSHKey
• UserUsername

The array indices start at 0 and end at UserCount - 1.

This property is not available at design time.

Data Type

Integer

UserAssociatedData Property (UserManager Class)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserAssociatedData(int iUserIndex, char* &lpUserAssociatedData, int &lenUserAssociatedData);
int SetUserAssociatedData(int iUserIndex, const char* lpUserAssociatedData, int lenUserAssociatedData);

Unicode (Windows)
INT GetUserAssociatedData(INT iUserIndex, LPSTR &lpUserAssociatedData, INT &lenUserAssociatedData);
INT SetUserAssociatedData(INT iUserIndex, LPCSTR lpUserAssociatedData, INT lenUserAssociatedData);

int secureblackbox_usermanager_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_usermanager_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);

QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserBasePath Property (UserManager Class)

Base path for this user in the server's file system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, const char* lpszUserBasePath);

Unicode (Windows)
LPWSTR GetUserBasePath(INT iUserIndex);
INT SetUserBasePath(INT iUserIndex, LPCWSTR lpszUserBasePath);

char* secureblackbox_usermanager_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);

QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserCert Property (UserManager Class)

Contains the user's certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserCert(int iUserIndex, char* &lpUserCert, int &lenUserCert);
int SetUserCert(int iUserIndex, const char* lpUserCert, int lenUserCert);

Unicode (Windows)
INT GetUserCert(INT iUserIndex, LPSTR &lpUserCert, INT &lenUserCert);
INT SetUserCert(INT iUserIndex, LPCSTR lpUserCert, INT lenUserCert);

int secureblackbox_usermanager_getusercert(void* lpObj, int userindex, char** lpUserCert, int* lenUserCert);
int secureblackbox_usermanager_setusercert(void* lpObj, int userindex, const char* lpUserCert, int lenUserCert);

QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserData Property (UserManager Class)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, const char* lpszUserData);

Unicode (Windows)
LPWSTR GetUserData(INT iUserIndex);
INT SetUserData(INT iUserIndex, LPCWSTR lpszUserData);

char* secureblackbox_usermanager_getuserdata(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserdata(void* lpObj, int userindex, const char* lpszUserData);

QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserHandle Property (UserManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, int64 lUserHandle);

Unicode (Windows)
LONG64 GetUserHandle(INT iUserIndex);
INT SetUserHandle(INT iUserIndex, LONG64 lUserHandle);

int64 secureblackbox_usermanager_getuserhandle(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);

qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Long64

UserHashAlgorithm Property (UserManager Class)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, const char* lpszUserHashAlgorithm);

Unicode (Windows)
LPWSTR GetUserHashAlgorithm(INT iUserIndex);
INT SetUserHashAlgorithm(INT iUserIndex, LPCWSTR lpszUserHashAlgorithm);

char* secureblackbox_usermanager_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);

QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserIncomingSpeedLimit Property (UserManager Class)

Specifies the incoming speed limit for this user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

Unicode (Windows)
INT GetUserIncomingSpeedLimit(INT iUserIndex);
INT SetUserIncomingSpeedLimit(INT iUserIndex, INT iUserIncomingSpeedLimit);

int secureblackbox_usermanager_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);

int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpAlgorithm Property (UserManager Class)

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);

Unicode (Windows)
INT GetUserOtpAlgorithm(INT iUserIndex);
INT SetUserOtpAlgorithm(INT iUserIndex, INT iUserOtpAlgorithm);

OA_NONE(0), 
OA_HMAC(1), 
OA_TIME(2)

int secureblackbox_usermanager_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);

int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOtpValue Property (UserManager Class)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);

Unicode (Windows)
INT GetUserOtpValue(INT iUserIndex);
INT SetUserOtpValue(INT iUserIndex, INT iUserOtpValue);

int secureblackbox_usermanager_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);

int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserOutgoingSpeedLimit Property (UserManager Class)

Specifies the outgoing speed limit for this user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

Unicode (Windows)
INT GetUserOutgoingSpeedLimit(INT iUserIndex);
INT SetUserOutgoingSpeedLimit(INT iUserIndex, INT iUserOutgoingSpeedLimit);

int secureblackbox_usermanager_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_usermanager_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);

int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserPassword Property (UserManager Class)

The user's authentication password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, const char* lpszUserPassword);

Unicode (Windows)
LPWSTR GetUserPassword(INT iUserIndex);
INT SetUserPassword(INT iUserIndex, LPCWSTR lpszUserPassword);

char* secureblackbox_usermanager_getuserpassword(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);

QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

UserPasswordLen Property (UserManager Class)

Specifies the length of the user's OTP password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);

Unicode (Windows)
INT GetUserPasswordLen(INT iUserIndex);
INT SetUserPasswordLen(INT iUserIndex, INT iUserPasswordLen);

int secureblackbox_usermanager_getuserpasswordlen(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserpasswordlen(void* lpObj, int userindex, int iUserPasswordLen);

int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);

Default Value

0

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Integer

UserSharedSecret Property (UserManager Class)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserSharedSecret(int iUserIndex, char* &lpUserSharedSecret, int &lenUserSharedSecret);
int SetUserSharedSecret(int iUserIndex, const char* lpUserSharedSecret, int lenUserSharedSecret);

Unicode (Windows)
INT GetUserSharedSecret(INT iUserIndex, LPSTR &lpUserSharedSecret, INT &lenUserSharedSecret);
INT SetUserSharedSecret(INT iUserIndex, LPCSTR lpUserSharedSecret, INT lenUserSharedSecret);

int secureblackbox_usermanager_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_usermanager_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);

QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserSSHKey Property (UserManager Class)

Contains the user's SSH key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserSSHKey(int iUserIndex, char* &lpUserSSHKey, int &lenUserSSHKey);
int SetUserSSHKey(int iUserIndex, const char* lpUserSSHKey, int lenUserSSHKey);

Unicode (Windows)
INT GetUserSSHKey(INT iUserIndex, LPSTR &lpUserSSHKey, INT &lenUserSSHKey);
INT SetUserSSHKey(INT iUserIndex, LPCSTR lpUserSSHKey, INT lenUserSSHKey);

int secureblackbox_usermanager_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_usermanager_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);

QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey);

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

Byte Array

UserUsername Property (UserManager Class)

The registered name (login) of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, const char* lpszUserUsername);

Unicode (Windows)
LPWSTR GetUserUsername(INT iUserIndex);
INT SetUserUsername(INT iUserIndex, LPCWSTR lpszUserUsername);

char* secureblackbox_usermanager_getuserusername(void* lpObj, int userindex);
int secureblackbox_usermanager_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);

QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is not available at design time.

Data Type

String

Config Method (UserManager Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_usermanager_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its 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.

DoAction Method (UserManager Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_usermanager_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its 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.

Load Method (UserManager Class)

Loads a user database from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Load(const char* lpszFilename, const char* lpszPassword);

Unicode (Windows)
INT Load(LPCWSTR lpszFilename, LPCWSTR lpszPassword);

int secureblackbox_usermanager_load(void* lpObj, const char* lpszFilename, const char* lpszPassword);

int Load(const QString& qsFilename, const QString& qsPassword);

Remarks

Use this method to load user information from a file specified by Filename. Provide a Password to decrypt the user information.

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

LoadFromStream Method (UserManager Class)

Loads a user database from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadFromStream(SecureBlackboxStream* sInputStream, const char* lpszPassword);

Unicode (Windows)
INT LoadFromStream(SecureBlackboxStream* sInputStream, LPCWSTR lpszPassword);

int secureblackbox_usermanager_loadfromstream(void* lpObj, SecureBlackboxStream* sInputStream, const char* lpszPassword);

int LoadFromStream(SecureBlackboxStream* sInputStream, const QString& qsPassword);

Remarks

Use this method to load the user information from InputStream. Provide a Password to decrypt the user information.

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

LoadUser Method (UserManager Class)

Imports the settings of the current user from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadUser(int iIndex, const char* lpszPath);

Unicode (Windows)
INT LoadUser(INT iIndex, LPCWSTR lpszPath);

int secureblackbox_usermanager_loaduser(void* lpObj, int iIndex, const char* lpszPath);

int LoadUser(int iIndex, const QString& qsPath);

Remarks

Use this method to load the current user's settings which were saved by Save. Path specifies the file containing the database.

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

LoadUserFromStream Method (UserManager Class)

Imports the details of the currently selected user from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadUserFromStream(int iIndex, SecureBlackboxStream* sInputStream);

Unicode (Windows)
INT LoadUserFromStream(INT iIndex, SecureBlackboxStream* sInputStream);

int secureblackbox_usermanager_loaduserfromstream(void* lpObj, int iIndex, SecureBlackboxStream* sInputStream);

int LoadUserFromStream(int iIndex, SecureBlackboxStream* sInputStream);

Remarks

Use this method to read the current user's settings from a stream.

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

Save Method (UserManager Class)

Saves the user database to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Save(const char* lpszFilename, const char* lpszPassword);

Unicode (Windows)
INT Save(LPCWSTR lpszFilename, LPCWSTR lpszPassword);

int secureblackbox_usermanager_save(void* lpObj, const char* lpszFilename, const char* lpszPassword);

int Save(const QString& qsFilename, const QString& qsPassword);

Remarks

Use this method to save the settings of all users to a file.

Use a non-empty Password to protect the database.

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

SaveToStream Method (UserManager Class)

Saves the user database to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveToStream(SecureBlackboxStream* sOutputStream, const char* lpszPassword);

Unicode (Windows)
INT SaveToStream(SecureBlackboxStream* sOutputStream, LPCWSTR lpszPassword);

int secureblackbox_usermanager_savetostream(void* lpObj, SecureBlackboxStream* sOutputStream, const char* lpszPassword);

int SaveToStream(SecureBlackboxStream* sOutputStream, const QString& qsPassword);

Remarks

Use this method to save the settings of all users in a stream.

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

SaveUser Method (UserManager Class)

Saves the settings of the current user to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveUser(int iIndex, const char* lpszPath);

Unicode (Windows)
INT SaveUser(INT iIndex, LPCWSTR lpszPath);

int secureblackbox_usermanager_saveuser(void* lpObj, int iIndex, const char* lpszPath);

int SaveUser(int iIndex, const QString& qsPath);

Remarks

Use this method to save the settings of the selected user to the file specified by Path.

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

SaveUserToStream Method (UserManager Class)

Saves the settings of the current user to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveUserToStream(int iIndex, SecureBlackboxStream* sOutputStream);

Unicode (Windows)
INT SaveUserToStream(INT iIndex, SecureBlackboxStream* sOutputStream);

int secureblackbox_usermanager_saveusertostream(void* lpObj, int iIndex, SecureBlackboxStream* sOutputStream);

int SaveUserToStream(int iIndex, SecureBlackboxStream* sOutputStream);

Remarks

Use this method to export the current user's settings to a stream.

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

Error Event (UserManager Class)

Reports error information during its work.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(UserManagerErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} UserManagerErrorEventParams;


Unicode (Windows)
virtual INT FireError(UserManagerErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} UserManagerErrorEventParams;

#define EID_USERMANAGER_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class UserManagerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(UserManagerErrorEventParams *e);

// Or, subclass UserManager and override this emitter function.
virtual int FireError(UserManagerErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during user management operations.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (UserManager Class)

This event notifies the application about an underlying control flow event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(UserManagerNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} UserManagerNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(UserManagerNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} UserManagerNotificationEventParams;

#define EID_USERMANAGER_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class UserManagerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(UserManagerNotificationEventParams *e);

// Or, subclass UserManager and override this emitter function.
virtual int FireNotification(UserManagerNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The UserManager class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the UserManager class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (UserManager Class)

UserManager Config Settings

Base Config Settings

Trappable Errors (UserManager Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

UserManager Errors