IEnumVARIANT

バリアントのコレクション(オブジェクトと組み込み型が混在する異種コレクションを含む)を列挙するためのメソッドを提供します。

IEnumVARIANT を使用してオブジェクトのコレクションを実装する方法については、Lines サンプルコードの Enumvar.cpp ファイルを参照してください。

列挙シーケンス内の指定された項目を取得します。

このメソッドは次のいずれかの値を返すことがあります。

シーケンスに残っている要素が要求された数より少ない場合、Next は残りの要素のみを返します。実際の要素数は、null でない限り pCeltFetched に返されます。

例

以下のコードは IEnumVariant::Next を実装しています。IEnumVariant インターフェースの完全な実装例は、COM Fundamentals の Lines サンプル(Enumvar.cpp)にあります。

STDMETHODIMP
CEnumVariant::Next(ULONG cElements, VARIANT * pvar, ULONG * pcElementFetched)
{
   HRESULT hr;
   ULONG l;
   long l1;
   ULONG l2;

   if (pcElementFetched != NULL)
      *pcElementFetched = 0;

   if (pvar == NULL)
      return E_INVALIDARG;

   for (l=0; l<cElements; l++)
      VariantInit(&pvar[l]);

   // Retrieve the next cElements elements.
   // m_lLBound+m_cElements = # of elements in the m_psa collection.

   for (l1=m_lCurrent, l2=0; l1<(long)(m_lLBound+m_cElements) &&
      l2<cElements; l1++, l2++)
   {
      hr = SafeArrayGetElement(m_psa, &l1, &pvar[l2]); 
      if (FAILED(hr))
         goto error; 
   }
   // Set count of elements retrieved.
   if (pcElementFetched != NULL)
      *pcElementFetched = l2;
   m_lCurrent = l1;

   return  (l2 < cElements) ? S_FALSE : NOERROR;

error:
   for (l=0; l<cElements; l++)
      VariantClear(&pvar[l]);
   return hr;
}

列挙シーケンス内の次の celt 個の要素をスキップしようとします。

このメソッドは次のいずれかの値を返すことがあります。

列挙シーケンスを先頭にリセットします。(IEnumVARIANT.Reset)

このメソッドは次のいずれかの値を返すことがあります。

2 回目の列挙で 1 回目とまったく同じバリアントの集合が列挙されるという保証はありません。完全に同一であることが望ましいものの、結果は列挙対象のコレクションに依存します。コレクションによっては、この条件を維持することが現実的でない場合があります(例えば、ディレクトリ内のファイルの列挙など)。

例

以下のコードは IEnumVariant::Reset を実装しています。IEnumVariant インターフェースの完全な実装例は、COM Fundamentals の Lines サンプル(Enumvar.cpp)にあります。

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

現在の列挙状態のコピーを作成します。

このメソッドは次のいずれかの値を返すことがあります。

この関数を使用すると、列挙シーケンス内の特定の位置を記録し、後でその位置に戻ることができます。返される列挙子は、複製元と同じ実際のインターフェースを持ちます。

2 回目の列挙で 1 回目とまったく同じバリアントの集合が列挙されるという保証はありません。完全に同一であることが望ましいものの、結果は列挙対象のコレクションに依存します。コレクションによっては、この条件を維持することが現実的でない場合があります(例えば、ディレクトリ内のファイルの列挙など)。

例

以下のコードは IEnumVariant::Clone を実装しています。IEnumVariant インターフェースの完全な実装例は、COM Fundamentals の Lines サンプル(Enumvar.cpp)にあります。

STDMETHODIMP
CEnumVariant::Clone(IEnumVARIANT ** ppenum)
{
   CEnumVariant * penum = NULL;
   HRESULT hr;

   if (ppenum == NULL)
      return E_INVALIDARG;

   *ppenum = NULL;

   hr = CEnumVariant::Create(m_psa, m_cElements, &penum);
   if (FAILED(hr))
      goto error;
   penum->AddRef();
   penum->m_lCurrent = m_lCurrent;

   *ppenum = penum;
   return NOERROR;

error:
   if (penum)
      penum->Release();
   return hr;
}