nn::nex::DuplicatedObject::AttemptEmigration Member Function

Syntax

qBool AttemptEmigration(
     DOHandle hNewLocation
);

Parameters

Name Description
in hNewLocation 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.

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). This function is asynchronous and therefore completes immediately.

See Also

Emigrate, MigrationInProgress

Revision History

2012/01/26
Initial version.

CONFIDENTIAL