nn::nex::DuplicatedObject::DeleteMainRef Member Function

Syntax

qBool DeleteMainRef();

Parameters

None.

Return Values

Description

Instructs the system to delete the main reference to the duplicated object.

Calling this function deletes the main reference (system reference) to the duplicated object held in the duplicated object store. If an object's main reference is deleted, the datasets held by that object are no longer refreshed and shortly thereafter it can no longer be seen in iterated selections.

If the main reference was the only reference to the object, then the duplicated object destructor is called and the duplicated object is deleted by this call. If there are any surviving references to the duplication master or duplicas of this duplicated object (for example if there are references to this object that use RefTemplate), the destructor is not executed until the last reference is released. When the destructor is called, all duplicas of this object are deleted.

This function can only be called by the duplication master. This function can be called even if the Publish function has not yet been called on the duplication object.

See Also

~DuplicatedObject, MainRefIsDeleted

Revision History

2011/01/27
Initial version.

CONFIDENTIAL