This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

ModelHistoryTakeModifications Method (String, IEnumerableModelObjectModelObjectEnum, ModificationStamp)

Take modifications since previous call, with object type filtering.

Namespace: Tekla.Structures.Model.History
Assembly: Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2022.0.13611

Syntax

Copy

public static ModificationInfo TakeModifications(
	string Name,
	IEnumerable<ModelObjectModelObjectEnum> ObjectTypes,
	ModificationStamp PrevStamp = null
)

Public Shared Function TakeModifications ( 
	Name As String,
	ObjectTypes As IEnumerable(Of ModelObjectModelObjectEnum),
	Optional PrevStamp As ModificationStamp = Nothing
) As ModificationInfo

Parameters

Name: Type: SystemString
Name of reference which is used for collecting modifications and which is updated. Intended use is to assign an unique name for each client application which needs to be informed of the model updates. Maximum length is 79 characters.
ObjectTypes: Type: System.Collections.GenericIEnumerableModelObjectModelObjectEnum
Types of object to select. Empty or null selects all types.
PrevStamp (Optional): Type: Tekla.Structures.Model.HistoryModificationStamp
When specified, default value of reference if is it not found

Return Value

Type: ModificationInfo
All modifications which happened since the last call. See ModificationInfo reference

Remarks

Same as TakeModifications(String, ModificationStamp), but returns only the types listed in ObjectTypes. Note that since this function also sets base for the next invocation of

Copy

TakeModifications()

for ALL objects, so using it discards change information for filtered objects.

Reference

ModelHistory Class

TakeModifications Overload

Tekla.Structures.Model.History Namespace

API Reference

Parameters

Return Value

Reference