This callback is invoked by the Target API for each model enumerated.

Namespace:  Quanser.Targets
Assembly:  Quanser.Targets (in Quanser.Targets.dll)

Syntax

Visual Basic (Declaration)
Function EnumerateModel ( _
	target As Target, _
	context As Object, _
	model_name As String, _
	model_arguments As String _
) As Integer
C#
int EnumerateModel(
	Target target,
	Object context,
	string model_name,
	string model_arguments
)
Visual C++
int EnumerateModel(
	Target^ target, 
	Object^ context, 
	String^ model_name, 
	String^ model_arguments
)
JavaScript
function enumerateModel(target, context, model_name, model_arguments);

Parameters

target
Type: Quanser.Targets..::.Target
The target instance.
context
Type: System..::.Object
The context provided when the enumeration was started.
model_name
Type: System..::.String
The name of the model.
model_arguments
Type: System..::.String
The arguments passed to the model, if any.

Return Value

Remarks

This method is invoked for each model enumerated. If the return value is negative then this is interpreted to mean that the enumeration should be stopped. To continue enumeration, return zero from the callback.

The callback may be used to update a graphical user interface showing the models that are currently loaded, for instance, and allowing the user to cancel the enumeration. The enumeration is cancelled if the callback returns a negative value.

See Also