CComEnumOnSTL クラス

[アーティクル]
06/09/2015

このクラスは、STL コレクションに基づいた COM 列挙子オブジェクトを定義します。

template < 
   class Base, 
   const IID* piid, 
   class T, 
   class Copy, 
   class CollType, 
   class ThreadModel = CComObjectThreadModel 
> 
class ATL_NO_VTABLE CComEnumOnSTL : 
   public IEnumOnSTLImpl<Base, piid, T, Copy, CollType>, 
   public CComObjectRootEx< ThreadModel >

パラメーター

Base
COM 列挙子インターフェイス (IEnumXXXX)。
piid
列挙子インターフェイスのインターフェイス ID へのポインター。
T
列挙子インターフェイスによって公開される項目の種類。
Copy
コピーポリシーのクラス。
CollType
STL コンテナークラス。

解説

CComEnumOnSTL は、STL コレクションに基づいた COM 列挙子オブジェクトを定義します。このクラスは、単独でまたは ICollectionOnSTLImplとともに使用できます。このクラスを使用する一般的な手順を次説明します。詳細については、ATL のコレクションと列挙子を参照してください。

ICollectionOnSTLImpl のこのクラスを使用するには:

typedef このクラスの特殊化。
ICollectionOnSTLImplの特殊化で最終的なテンプレート引数として typedef を使用します。

例については ATL のコレクションと列挙子を参照してください。

このクラスを ICollectionOnSTLImpl とは関係なく使用するには:

typedef このクラスの特殊化。
CComObjectの特殊化でテンプレート引数として typedef を使用します。
CComObject の特化型のインスタンスを作成します。
IEnumOnSTLImpl::Initを呼び出して、列挙子オブジェクトを初期化します。
クライアントに列挙子インターフェイスを返します。

継承階層

CComObjectRootBase

Base

CComObjectRootEx

IEnumOnSTLImpl

CComEnumOnSTL

必要条件

ヘッダー : atlcom.h

使用例

以下のコードは、列挙子オブジェクトの作成と初期化を処理するジェネリック関数が用意されています:

template <class EnumType, class CollType>
HRESULT CreateSTLEnumerator(IUnknown** ppUnk, IUnknown* pUnkForRelease, 
   CollType& collection)
{
   if (ppUnk == NULL)
      return E_POINTER;
   *ppUnk = NULL;

   CComObject<EnumType>* pEnum = NULL;
   HRESULT hr = CComObject<EnumType>::CreateInstance(&pEnum);

   if (FAILED(hr))
      return hr;

   hr = pEnum->Init(pUnkForRelease, collection);

   if (SUCCEEDED(hr))
      hr = pEnum->QueryInterface(ppUnk);

   if (FAILED(hr))
      delete pEnum;

   return hr;
} // CreateSTLEnumerator

このテンプレート関数は、次に示すように、コレクションインターフェイスの _NewEnum のプロパティを実装するために使用できます:

typedef CComEnumOnSTL<IEnumVARIANT, &IID_IEnumVARIANT, VARIANT, _Copy<VARIANT>,
   std::vector<CComVariant> > VarVarEnum;

class ATL_NO_VTABLE CVariantCollection :
   public CComObjectRootEx<CComSingleThreadModel>,
   public CComCoClass<CVariantCollection, &CLSID_VariantCollection>,
   public IDispatchImpl<IVariantCollection, &IID_IVariantCollection, &LIBID_NVC_ATL_COMLib, /*wMajor =*/ 1, /*wMinor =*/ 0>
{
public:
   std::vector<CComVariant> m_vec;

   STDMETHOD(get__NewEnum)(IUnknown** ppUnk)
   {
      return CreateSTLEnumerator<VarVarEnum>(ppUnk, this, m_vec);
   }

   // Remainder of class declaration omitted.

IEnumVariant のインターフェイスで CComVariant、のベクターを公開するこのコードは CComEnumOnSTL の typedef を作成します。 CVariantCollection のクラスはこの型の列挙子オブジェクトを使用するに CreateSTLEnumerator を単純に特化します。

参照

概念

ATLCollections サンプル: ICollectionOnSTLImpl、CComEnumOnSTL、およびカスタムコピーポリシークラスを示します

その他の技術情報

ATL クラスの概要

次の方法で共有