C-DEngine 5.105

TheThing..::..RestartUpdateHistory Method (Guid, TheHistoryParameters)

Restarts history retrieval from the point when ClearUpdateHistory was last called. Call this when complete history is required, and a failure during processing requires a retry. For durable history tokens, call this after a restart.

Namespace:  nsCDEngine.Engines.ThingService
Assembly:  C-DEngine (in C-DEngine.dll)

Syntax

public bool RestartUpdateHistory(
	Guid historyToken,
	TheHistoryParameters historyParameters
)
Public Function RestartUpdateHistory ( _
	historyToken As Guid, _
	historyParameters As TheHistoryParameters _
) As Boolean
public:
bool^ RestartUpdateHistory(
	Guid^ historyToken, 
	TheHistoryParameters^ historyParameters
)

Parameters

historyToken
Type: Guid
The token returned by RegisterForUpdateHistory.
historyParameters
Type: nsCDEngine.Engines.ThingService..::..TheHistoryParameters
History parameters expected to be returned. If the parameters can not be satisfied with existing history, the token is invalidated (and the method returns false)

Return Value

true if the history token was valid and has been restarted. false if the token was invalid or the historyParameters were incompatible with existing history data.

See Also

TheThing Class
RestartUpdateHistory Overload
nsCDEngine.Engines.ThingService Namespace