IRemoteArgumentDictionaryEnumeratorContract.GetEntry Method

Definition

Returns the key and the value of the current IRemoteArgumentDictionaryContract entry.

public:
 System::AddIn::Contract::Collections::RemoteArgumentDictionaryEntry GetEntry();
public System.AddIn.Contract.Collections.RemoteArgumentDictionaryEntry GetEntry ();
abstract member GetEntry : unit -> System.AddIn.Contract.Collections.RemoteArgumentDictionaryEntry
Public Function GetEntry () As RemoteArgumentDictionaryEntry

Returns

A RemoteArgumentDictionaryEntry that contains the key and the value of the current IRemoteArgumentDictionaryContract entry.

Exceptions

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 GetEntry method; otherwise, the return value of GetEntry is undefined.

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

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

Applies to