nn::nex::DuplicatedObject::Refresh Member Function

Syntax

qBool Refresh();

Parameters

None.

Return Values



Value Description
true Returned when transfer was successful.
false Returned when transfer failed. If a duplication master calls this function, the SYSTEMERROR_OBJDUP_INVALID_ON_MASTER error is signaled.

Description

Transfers duplica dataset information from the buffer.

If the Data Definition Language (DDL) file specifies to use buffers with datasets, the datasets are not immediately refreshed when messages are received. These messages are temporarily pooled in the buffer. If the DDL file specifies the buffered property (use a buffer) or the extrapolation_filter property (use dead reckoning), the corresponding datasets use the buffer.

Use of this function refreshes all duplica datasets using the information that has accumulated in the buffer.

This function can only be called when the duplicated object instance is a duplica.

On CTR, for load reduction purposes we recommend using one of the overloaded functions that explicitly specifies the session clock.

See Also

IsADuplica

Revision History

2012/01/27
Initial version.

CONFIDENTIAL