CogOCVMaxCharacterIterator.Copy Method (Int32)

CogOCVMaxCharacterIterator Copy Method (Int32)

Cognex VisionPro 9.8

Return a newly created character iterator corresponding to the specified character position within the same enclosing line and the same enclosing paragraph as this character iterator. The argument is a positional offset from the current character position, so a value of zero will yield a new character iterator that is functionally identical to this one.

Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 75.1.0.0

Syntax

C++

Copy to Clipboard Print

public CogOCVMaxCharacterIterator Copy(
	int PositionOffset
)

public CogOCVMaxCharacterIterator Copy(
	int PositionOffset
)

Public Function Copy ( 
	PositionOffset As Integer
) As CogOCVMaxCharacterIterator

Public Function Copy ( 
	PositionOffset As Integer
) As CogOCVMaxCharacterIterator

public:
CogOCVMaxCharacterIterator^ Copy(
	int PositionOffset
)

public:
CogOCVMaxCharacterIterator^ Copy(
	int PositionOffset
)

Parameters

PositionOffset: Type: System Int32
A System::Int32 that is added to the character position index of this character iterator to yield a new character position index within the enclosing line. If this computation results in a character position index that is not valid, an exception is generated.

Return Value

Type: CogOCVMaxCharacterIterator
A CogOCVMaxCharacterIterator corresponding to the specified character position with the containing line within the containing paragraph.

Exceptions

Exception	Condition
ObjectDisposedException	If the associated CogOCVMaxPattern object has already been disposed.
InvalidOperationException	If this character iterator cannot be found.
ArgumentOutOfRangeException	If the character position index computed from the supplied argument is less than zero or greater than the number of characters in the enclosing line.