nn::nex::DuplicatedObject::Emigrate Member Function

Syntax

qBool Emigrate(
     MigrationContext * pContext,
     DOHandle hTargetStation
);

Parameters

Name Description
in pContext Specifies a pointer to this call's MigrationContext.
in hTargetStation Specifies the duplicated object handle of the station to which to migrate the duplicated object.

Return Values



Value Description
true Returned when the call started normally.
false Returned when the call did not start normally. The SYSTEMERROR_OBJDUP_CANNOT_EMIGRATE or the SYSTEMERROR_OBJDUP_INVALID_ON_DUPLICA error is signaled.

Description

Causes this duplicated object to emigrate to the specified station.

Migration is the act of transferring control of a duplicated object to a different station. There are two main processes in migration. The first process to execute is emigration and refers to transferring control of a duplicated object. The next process to execute is immigration and refers to receiving a duplicated object. This function performs emigration.

This function must only be called by duplication masters (see IsADuplicationMaster). When the specified pContext has been initialized and you specify synchronous execution in the constructor, this function call does not end immediately. Instead, control does not return until execution completes or an error occurs. If you specify asynchronous execution, this function call ends immediately.

See Also

AttemptEmigration, MigrationInProgress

Revision History

2012/01/26
Initial version.

CONFIDENTIAL