IEnumVARIANT::Reset

HRESULT Reset()

Resets the enumeration sequence to the beginning.

Parameters

None

Return Value

The return value obtained from the returned HRESULT is one of the following:

Return value Meaning
S_OK Success.
S_FALSE Failure.

Comments

There is no guarantee that exactly the same set of variants will be enumerated the second time as was enumerated the first time. Although an exact duplicate is desirable, the outcome depends on the collection being enumerated. You may find that it is impractical for some collections to maintain this condition (for example, an enumeration of the files in a directory).

Example

The following code implements IEnumVariant::Reset for collections in the Lines sample file Enumvar.cpp:

STDMETHODIMP
CEnumVariant::Reset()
{
    m_lCurrent = m_lLBound;
    return NOERROR;
}