ICogRunStatus Interface

Cognex VisionPro 9.8 SR1

This interface is returned by the RunStatus property of the ICogTool interface and provides general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 75.0.0.0 (75.0.0.0)

Syntax

C++

Copy to Clipboard Print

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface ICogRunStatus

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface ICogRunStatus

<TypeConverterAttribute(GetType(CogComponentConverter))> 
Public Interface ICogRunStatus

<TypeConverterAttribute(GetType(CogComponentConverter))> 
Public Interface ICogRunStatus

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface class ICogRunStatus

[TypeConverterAttribute(typeof(CogComponentConverter))]
public interface class ICogRunStatus

The ICogRunStatus type exposes the following members.

Properties

	Name	Description
	Exception	Returns the exception that happened when the tool's Run method was called, or null if no exception happened.
	Message	Returns null if the result was Accept, and otherwise returns a string that provides additional information about the Warning, Reject or Error condition.
	ProcessingTime	Returns the time in miliseconds taken to perform the tool's processing when its Run function was called. This excludes the time taken by event handlers connected to the tool.
	Result	Gets a result code that indicates the overall result of running the tool.
	TotalTime	Returns the total time in milliseconds taken by the tool's Run function. This includes the time taken by event handlers connected to the tool.

Top