RandomExtensionsNextInt32(Random, Int32, Boolean) Method

Returns a non-negative random 32-bit signed integer that is within the specified maximum.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 7.2.0

C#

public static int NextInt32(
	this Random random,
	int maxValue,
	bool inclusiveUpperBound = false
)

VB

<ExtensionAttribute>
Public Shared Function NextInt32 ( 
	random As Random,
	maxValue As Integer,
	Optional inclusiveUpperBound As Boolean = false
) As Integer

C++

public:
[ExtensionAttribute]
static int NextInt32(
	Random^ random, 
	int maxValue, 
	bool inclusiveUpperBound = false
)

F#

[<ExtensionAttribute>]
static member NextInt32 : 
        random : Random * 
        maxValue : int * 
        ?inclusiveUpperBound : bool 
(* Defaults:
        let _inclusiveUpperBound = defaultArg inclusiveUpperBound false
*)
-> int

Parameters

random Random: The Random instance to use.
maxValue Int32: The upper bound of the random number returned.
inclusiveUpperBound Boolean (Optional): to allow that the generated value is equal to maxValue; otherwise, . This parameter is optional.
Default value: .

Return Value

Int32
A 32-bit signed integer that is greater than or equal to 0 and less than or equal to maxValue. If inclusiveUpperBound is , then maxValue is an exclusive upper bound; however, if maxValue equals 0, then 0 is returned.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Random. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException	random is .
ArgumentOutOfRangeException	maxValue is less than 0.