CogPMAlignRunParams.Timeout Property

CogPMAlignRunParams Timeout Property

Cognex VisionPro

The maximum execution time (msec) allowed to run a PMAlign inspection. If PMAlign has not finished by the end of the timeout period, it will stop soon thereafter and return E_Cog_TimeoutExpired. This value only applies if TimeoutEnabled is true.

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public double Timeout { get; set; }

public double Timeout { get; set; }

Public Property Timeout As Double 
	Get 
	Set

Public Property Timeout As Double 
	Get 
	Set

public:
property double Timeout {
	double get ();
	void set (double value);
}

public:
property double Timeout {
	double get ();
	void set (double value);
}

Property Value

Type: Double

Events

Event Type	Reason
CogPMAlignRunParams Changed	Fires when the value of this property changes. The following state flag may be affected: SfTimeout

Event Type

Reason

CogPMAlignRunParams Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfTimeout

Exceptions

Exception	Condition
ArgumentException	The supplied value is less than zero.

Remarks

The maximum execution time (msec) allowed to run a PMAlign inspection. If PMAlign has not finished by the end of the timeout period, it will stop soon thereafter and return CogPMAlignRunParams. This value only applies if TimeoutEnabled is true.

Default Value: 5000 milliseconds