RandomExtensionsNextByte(Random, Byte, Boolean) Method

Returns a random 8-bit unsigned 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 byte NextByte(
	this Random random,
	byte maxValue,
	bool inclusiveUpperBound = false
)

VB

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

C++

public:
[ExtensionAttribute]
static unsigned char NextByte(
	Random^ random, 
	unsigned char maxValue, 
	bool inclusiveUpperBound = false
)

F#

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

Parameters

random Random: The Random instance to use.
maxValue Byte: 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

Byte
An 8-bit unsigned 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 .