ITcVnRandomAccessIterator

Offers an interface for a random access iterator.

Inheritance Hierarchy

ITcUnknown
    ITcVnIteratorBase
        ITcVnForwardIterator
            ITcVnBidirectionalIterator
                ITcVnRandomAccessIterator

Methods

Name	Origin	Description
TcAddRef	ITcUnknown	Increments the reference counter.
TcQueryInterface	ITcUnknown	Get a reference to an implemented interface.
TcRelease	ITcUnknown	Decrements the reference counter.
CheckIfBegin	ITcVnIteratorBase	Checks if the iterator points to the first element.
CheckIfEnd	ITcVnIteratorBase	Checks if the iterator points to the past-the-end element (alternatively use F_VN_CheckIfIteratorIsAtEnd).
GetValueSize	ITcVnIteratorBase	Gets the memory size (in byte) required by the value the iterator points to.
GetValueTypeGuid	ITcVnIteratorBase	Gets the type GUID of the value the iterator points to.
SetToBegin	ITcVnIteratorBase	Sets the iterator to the first element (alternatively use F_VN_SetIteratorToBegin).
SetToEnd	ITcVnIteratorBase	Sets the iterator to the past-the-end element.
CheckIfEqualTo	ITcVnForwardIterator	Checks if iterator is equal to another iterator.
GetContainer	ITcVnForwardIterator	Gets a pointer to the current element converted into an ITcVnContainer interface and increment its reference counter (only possible for container types). (Alternatively use F_VN_GetContainer.)
Increment	ITcVnForwardIterator	Increments the iterator. (Alternatively use F_VN_IncrementIterator.)
SetContainer	ITcVnForwardIterator	Sets the current element using an ITcVnContainer interface (only possible for container types). (Alternatively use F_VN_SetContainer.)
Decrement	ITcVnBidirectionalIterator	Decrements the iterator.
CheckIfGreaterThan	ITcVnRandomAccessIterator	Checks if the iterator is greater than another iterator.
CheckIfLessThan	ITcVnRandomAccessIterator	Checks if the iterator is less than another iterator.
GetContainerAt	ITcVnRandomAccessIterator	Gets a pointer to the element at a specific offset from the current element converted into an ITcVnContainer interface and increment its reference counter (only possible for container types). (Alternatively use F_VN_GetAt_ITcVnContainer.)
SetContainerAt	ITcVnRandomAccessIterator	Sets the element at a specific offset from the current element using an ITcVnContainer interface (only possible for container types). (Alternatively use F_VN_SetAt_ITcVnContainer.)

System Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT V3.1.4024.54 or later	PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU	Tc3_Vision

Further Information