nn::nex::Station::ApproveEmigration Member Function

Syntax

virtual qBool ApproveEmigration(
     qUnsignedInt32 uiReason
);

Parameters

Name Description
in uiReason MIGRATION_REASON_LEAVING_SESSION is always specified.

Return Values



Value Description
true Migrates the duplicated object. The duplicated object existed previously in the session, and now transfers its control to a station remaining in the session.
false Does not migrate the duplicated object. The duplicated object existed in the session until now, and will now be destroyed.

Description

Returns whether the duplicated object migrates.

Migration is the act of transferring control of a duplicated object to a different station. In a normal sequence, this function is called by the system immediately before a station leaves the session. The function returns whether to transfer control of that station's objects to another station. The application can override this function and change behavior.

To implement a feature that preserves duplicated objects in the event of a fault (for example, power interruption causing a station to suddenly leave the session), override the ApproveFaultRecovery function, rather than this function.

Note: This function is provided so that it can be called by the system. Do not call it from the application.

See Also

ApproveFaultRecovery, RemoveFromStoreOperation

Revision History

2011/01/27
Initial version.

CONFIDENTIAL