GH_StateServer.RestoreState Method (Int32, Boolean, Int32, Int32)

GH_StateServerRestoreState Method (Int32, Boolean, Int32, Int32)

Restore a certain state.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public bool RestoreState(
	int index,
	bool recompute,
	out int restored_objects,
	out int missing_objects
)
Public Function RestoreState ( 
	index As Integer,
	recompute As Boolean,
	<OutAttribute> ByRef restored_objects As Integer,
	<OutAttribute> ByRef missing_objects As Integer
) As Boolean

Parameters

index
Type: SystemInt32
Index of state to restore.
recompute
Type: SystemBoolean
If True, a new solution will be started right away.
restored_objects
Type: SystemInt32
Number of objects successfully restored.
missing_objects
Type: SystemInt32
Number of objects that could not be found.

Return Value

Type: Boolean
True on success, false on failure.
See Also

M:Grasshopper.Kernel.GH_StateServer.RestoreState(System.Int32,System.Boolean,System.Int32@,System.Int32@)