Rnd Component

Properties   Methods   Events   Config Settings   Errors  

The Rnd component class is a basic provider of random number generation functionality.

Syntax

TsbxRnd

Remarks

Use Rnd control to generate pseudo-random numbers or sequences. Methods like NextBytes and NextInt return the next PRNG output, whereas SeedBytes or SeedInt seed the generator with outside entropy.

It is a good idea to use one shared (singleton) Rnd object per process, as it helps spread the entropy across many part of the project, resulting in better and more secure randomization.

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.

Alphabet Property (Rnd Component)

Alphabet to use for random string generation.

Syntax

__property String Alphabet = { read=FAlphabet, write=FSetAlphabet };

Default Value

""

Remarks

Use this property to provide a list of characters to be used by NextString method. The empty value has a special meaning, and is equivalent to 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'.

Data Type

String

FIPSMode Property (Rnd Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Config Method (Rnd Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

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

NextBytes Method (Rnd Component)

Generates an array of random bytes.

Syntax

DynamicArray<Byte> __fastcall NextBytes(int Len);

Remarks

Call this method to generate an array of random bytes of length Len.

NextInt Method (Rnd Component)

Generates a random integer.

Syntax

int __fastcall NextInt();

Remarks

Use this method to generate a random integer value.

NextPass Method (Rnd Component)

Generates a random password.

Syntax

String __fastcall NextPass(bool Lowercase, bool Uppercase, bool Digits, bool Specials, int Len);

Remarks

Use this method to generate a random password. Tune up the desired length and composition of the password using Lowercase, Uppercase, Digits, Specials, and Len parameters.

NextString Method (Rnd Component)

Generates a random string of characters.

Syntax

String __fastcall NextString(int Len);

Remarks

Use this method to generate a random string using characters supplied via the Alphabet property.

Randomize Method (Rnd Component)

Seeds the random generator with a system-originating input.

Syntax

void __fastcall Randomize();

Remarks

Use this method to randomize the generator by seeding it with a system-produced random input.

SeedBytes Method (Rnd Component)

Seeds the generator with a data in a byte array.

Syntax

void __fastcall SeedBytes(DynamicArray<Byte> Value);

Remarks

Use this method to seed the generator with data provided in a byte array.

SeedInt Method (Rnd Component)

Seeds the generator with an integer value.

Syntax

void __fastcall SeedInt(int IntValue);

Remarks

Use this method to seed the generator with an integer value.

SeedString Method (Rnd Component)

Seeds the generator with a string value.

Syntax

void __fastcall SeedString(String StrValue);

Remarks

Use this method to seed the generator with a string value.

SeedTime Method (Rnd Component)

Seeds the generator with current time.

Syntax

void __fastcall SeedTime();

Remarks

Use this method to seed the generator with current system time.

Error Event (Rnd Component)

Informs about errors during cryptographic operations.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxRndErrorEventParams;
typedef void __fastcall (__closure *TsbxRndErrorEvent)(System::TObject* Sender, TsbxRndErrorEventParams *e);
__property TsbxRndErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

Component fires this event if an error happens during a cryptographic operation.

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

Notification Event (Rnd Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxRndNotificationEventParams;
typedef void __fastcall (__closure *TsbxRndNotificationEvent)(System::TObject* Sender, TsbxRndNotificationEventParams *e);
__property TsbxRndNotificationEvent OnNotification = { 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.

Config Settings (Rnd 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.

Base Config Settings

Trappable Errors (Rnd Component)

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