IRemoteArgumentDictionaryEnumeratorContract.GetValue Method

Definition

Namespace:

System.AddIn.Contract.Collections

Assembly:

System.AddIn.Contract.dll

Returns the value of the current IRemoteArgumentDictionaryContract entry.

public:
 System::AddIn::Contract::RemoteArgument GetValue();

public System.AddIn.Contract.RemoteArgument GetValue ();

abstract member GetValue : unit -> System.AddIn.Contract.RemoteArgument

Public Function GetValue () As RemoteArgument

Returns

RemoteArgument

A RemoteArgument that contains the value of the current IRemoteArgumentDictionaryContract entry.

Exceptions

InvalidOperationException

The IRemoteArgumentDictionaryEnumeratorContract is positioned before the first entry of the IRemoteArgumentDictionaryContract or after the last entry.

Remarks

After an enumerator is created or after the Reset method is called, the MoveNext method must be called to advance the enumerator to the first element of the collection before calling the GetValue method; otherwise, the return value of GetValue is undefined.

GetValue also throws an exception if the last call to MoveNext returned false, which indicates the end of the collection.

GetValue does not move the position of the enumerator, and consecutive calls to GetValue return the same object until either MoveNext or Reset is called.