CogPMRedLineRunParams.NumberToFind Property

CogPMRedLineRunParams NumberToFind Property

Cognex VisionPro 9.7

Gets or sets the number of results to search for.

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public int NumberToFind { get; set; }

public int NumberToFind { get; set; }

Public Property NumberToFind As Integer 
	Get 
	Set

Public Property NumberToFind As Integer 
	Get 
	Set

public:
property int NumberToFind {
	int get ();
	void set (int value);
}

public:
property int NumberToFind {
	int get ();
	void set (int value);
}

Property Value

Type: Int32
The number of results to search for. Default value is 1.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfNumberToFind

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than one.

Remarks

You should set this value to the maximum number of pattern instances that you ever expect to find in your input image.

If the ReturnAllResults property of CogPMRedLineRunParams is "false", the number of results returned by PMRedLine will always be less than or equal to the value you specify. If ReturnAllResults is "true", you may get additional results.