[This is preliminary documentation and is subject to change.]
Tries to generate many consecutive IDs. If the reserved block gets exhausted, then the returned ID count may be less than requested.
Namespace: NFX.DataAccessAssembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
ConsecutiveUniqueSequenceIDs TryGenerateManyConsecutiveSequenceIDs(
string scopeName,
string sequenceName,
int idCount,
Nullable<ulong> vicinity = 18446744073709551615,
bool noLWM = false
)
ConsecutiveUniqueSequenceIDs TryGenerateManyConsecutiveSequenceIDs(
string scopeName,
string sequenceName,
int idCount,
Nullable<ulong> vicinity = 18446744073709551615,
bool noLWM = false
)
Function TryGenerateManyConsecutiveSequenceIDs (
scopeName As String,
sequenceName As String,
idCount As Integer,
Optional vicinity As Nullable(Of ULong) = 18446744073709551615,
Optional noLWM As Boolean = false
) As ConsecutiveUniqueSequenceIDs
Function TryGenerateManyConsecutiveSequenceIDs (
scopeName As String,
sequenceName As String,
idCount As Integer,
Optional vicinity As Nullable(Of ULong) = 18446744073709551615,
Optional noLWM As Boolean = false
) As ConsecutiveUniqueSequenceIDs
ConsecutiveUniqueSequenceIDs TryGenerateManyConsecutiveSequenceIDs(
String^ scopeName,
String^ sequenceName,
int idCount,
Nullable<unsigned long long> vicinity = 18446744073709551615,
bool noLWM = false
)
ConsecutiveUniqueSequenceIDs TryGenerateManyConsecutiveSequenceIDs(
String^ scopeName,
String^ sequenceName,
int idCount,
Nullable<unsigned long long> vicinity = 18446744073709551615,
bool noLWM = false
)
abstract TryGenerateManyConsecutiveSequenceIDs :
scopeName : string *
sequenceName : string *
idCount : int *
?vicinity : Nullable<uint64> *
?noLWM : bool
(* Defaults:
let _vicinity = defaultArg vicinity 18446744073709551615
let _noLWM = defaultArg noLWM false
*)
-> ConsecutiveUniqueSequenceIDs
abstract TryGenerateManyConsecutiveSequenceIDs :
scopeName : string *
sequenceName : string *
idCount : int *
?vicinity : Nullable<uint64> *
?noLWM : bool
(* Defaults:
let _vicinity = defaultArg vicinity 18446744073709551615
let _noLWM = defaultArg noLWM false
*)
-> ConsecutiveUniqueSequenceIDs
Parameters
- scopeName
- Type:
System String
The name of scope where sequences are kept
- sequenceName
- Type:
System String
The name of sequence within the scope for which ID to be obtained
- idCount
- Type:
System Int32
How many Consecutive IDs should the system try to reserve
- vicinity (Optional)
- Type:
System Nullable
UInt64
The location on ID counter scale, the issuing authority may disregard this parameter
- noLWM (Optional)
- Type:
System Boolean
When true, does not start async fetch of the next ID block while the current block reaches low-water-mark.
This may not be desired in some short-lived processes.
The provider may disregard this flag
Return Value
Type:
ConsecutiveUniqueSequenceIDsThe first uniqueID along with the number of Consecutive IDs that the system could allocate which can be less than requested number of IDs