nn::nex::IDGenerator::SetIDRange Member Function

Syntax

qBool SetIDRange(
     ID idFirst,
     ID idLast
);

Parameters

Name Description
idFirst [in] Specifies the ID to generate first.
idLast [in] Specifies the ID to generate last.

Return Values



Value Description
true Returned if the ID range was successfully set.
false Returned if an error occurred. SYSTEMERROR_OBJDUP_INVALID_ON_DUPLICA is signaled if this function was called on a duplica.

Description

Sets the range of IDs that can be generated by this IDGenerator.

This IDGenerator will now generate IDs in the range specified starting from the ID given by idFirst and that given by idLast.When the generated ID for the last value specified here is reached, subsequent calls to the GenerateID function will fail.

This function can only be called by the IDGenerator duplication master. Also, this function must be called before any stations have called the GenerateID function.

See Also

GenerateID, DuplicatedObject::IsADuplicationMaster

Revision History

2011/01/27
Initial version.

CONFIDENTIAL