AFCase.CollectInputs Method

public bool CollectInputs()

Public Function CollectInputs As Boolean

Dim instance As AFCase
Dim returnValue As Boolean

returnValue = instance.CollectInputs()

public:
bool CollectInputs()

member CollectInputs : unit -> bool 

Return Value

The AFAnalysisRule used by this method is defined by the AFAnalysis that owns this case. This is usually the first method called when starting an analysis.

If an input value has been previously collected and is already in the case's Results collection, then it will not be collected again. Use one of the Reset Overload methods to remove the input value from the results collection.

This method updates the CollectInputsTime property. If there are no errors, the CollectInputsTime will be set to the current time. If an error occurs, the time will be set to DateTime.MinValue to indicate that inputs have not been successfully collected.

The Before event is raised before this operation is started to allow clients an opportunity to perform any required validation or processing before starting the operation. The operation can also be canceled by setting the Cancel property of the AFCaseCancelEventArgs parameter to the event. The Executing event is raised during the execution of the operation to allow clients an opportunity to cancel and not wait for the operation to complete. The After event is raised after the operation is completed to allow clients an opportunity to perform any post-processing.

Security Note
You must have Execute security rights to collect inputs for a case.

AFSDK

Reference