IRemoteArgumentEnumeratorContract Interface

Definition

Namespace:

System.AddIn.Contract.Collections

Assembly:

System.AddIn.Contract.dll

Enumerates the elements of a collection of RemoteArgument objects.

public interface class IRemoteArgumentEnumeratorContract : System::AddIn::Contract::IContract

public interface IRemoteArgumentEnumeratorContract : System.AddIn.Contract.IContract

type IRemoteArgumentEnumeratorContract = interface
    interface IContract

Public Interface IRemoteArgumentEnumeratorContract
Implements IContract

Derived

System.AddIn.Contract.Collections.IRemoteArgumentDictionaryEnumeratorContract

Implements

IContract

Remarks

Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Initially, the enumerator is positioned before the first element in the collection. At this position, the return value of GetCurrent is undefined. Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before calling GetCurrent.

GetCurrent returns the same object until MoveNext is called. MoveNext sets the return value of GetCurrent to the next element.

If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. When the enumerator is at this position, subsequent calls to MoveNext also return false. If the last call to MoveNext returned false, the return value of GetCurrent is undefined.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined.

Methods

AcquireLifetimeToken()	Specifies that the contract is accessible to a client until the client revokes the contract. (Inherited from IContract)
GetCurrent()	Returns the RemoteArgument in the collection at the current position of the enumerator.
GetRemoteHashCode()	Returns a hash code for the IContract. (Inherited from IContract)
MoveNext()	Advances the enumerator to the next element of the collection.
QueryContract(String)	Returns a contract that is implemented by this contract. (Inherited from IContract)
RemoteEquals(IContract)	Indicates whether the specified contract is equal to this IContract. (Inherited from IContract)
RemoteToString()	Returns a string representation of the current IContract. (Inherited from IContract)
Reset()	Sets the enumerator to its initial position, which is before the first element in the collection.
RevokeLifetimeToken(Int32)	Specifies that the contract is no longer accessible to a client. (Inherited from IContract)