ICogGraphicMultiPen.GetPenKey Method

ICogGraphicMultiPen GetPenKey Method

Cognex VisionPro

Returns the key for the pen at the given Index. Index must be in the range from 0 to PenCount-1 (inclusive).

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

Syntax

int GetPenKey(
	int index
)

int GetPenKey(
	int index
)

Function GetPenKey ( 
	index As Integer
) As Integer

Function GetPenKey ( 
	index As Integer
) As Integer

int GetPenKey(
	int index
)

int GetPenKey(
	int index
)

Type: Int32

Exceptions

Exception	Condition
ArgumentException	index is < 0 or > (PenCount−1).

Remarks

Returns the key for the pen at the given index. Index must be in the range from 0 to PenCount−1.