UserManager Component

Properties   Methods   Events   Config Settings   Errors  

The UserManager component stores information about user accounts.

Syntax

TsbxUserManager

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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

FIPSMode Property (UserManager Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

Users Property (UserManager Component)

A collection of known users along with their connection settings.

Syntax

property Users: TsbxUserAccountList read get_Users write set_Users;

Remarks

Use this property to access the collection of known users and their details.

This property is not available at design time.

Please refer to the UserAccount type for a complete list of fields.

Config Method (UserManager Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoAction Method (UserManager Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

DoAction is a generic method available in every component. 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;....

Load Method (UserManager Component)

Loads a user database from a file.

Syntax

procedure Load(Filename: String; Password: String);

Remarks

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

LoadFromStream Method (UserManager Component)

Loads a user database from a stream.

Syntax

procedure LoadFromStream(InputStream: TStream; Password: String);

Remarks

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

LoadUser Method (UserManager Component)

Imports the settings of the current user from a file.

Syntax

procedure LoadUser(Index: Integer; Path: String);

Remarks

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

LoadUserFromStream Method (UserManager Component)

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

Syntax

procedure LoadUserFromStream(Index: Integer; InputStream: TStream);

Remarks

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

Save Method (UserManager Component)

Saves the user database to a file.

Syntax

procedure Save(Filename: String; Password: String);

Remarks

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

Use a non-empty Password to protect the database.

SaveToStream Method (UserManager Component)

Saves the user database to a stream.

Syntax

procedure SaveToStream(OutputStream: TStream; Password: String);

Remarks

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

SaveUser Method (UserManager Component)

Saves the settings of the current user to a file.

Syntax

procedure SaveUser(Index: Integer; Path: String);

Remarks

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

SaveUserToStream Method (UserManager Component)

Saves the settings of the current user to a stream.

Syntax

procedure SaveUserToStream(Index: Integer; OutputStream: TStream);

Remarks

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

Error Event (UserManager Component)

Reports error information during its work.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

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

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

>

constructor Create();

Creates a new UserAccount object.

Config Settings (UserManager Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

UserManager Config Settings

Base Config Settings

Trappable Errors (UserManager Component)

UserManager Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)