DECLARE_OBJECT_DESCRIPTION

  • [アーティクル]

更新 : 2007 年 11 月

クラス オブジェクトを説明する文字列を指定できます。

DECLARE_OBJECT_DESCRIPTION( 
      x  
)

パラメータ

  • x
    [入力] クラス オブジェクトについての説明。

解説

ATL は、OBJECT_ENTRY マクロを使用して、この説明をオブジェクト マップに入力します。

DECLARE_OBJECT_DESCRIPTION は、GetObjectDescription 関数を実装しています。この関数は、CComCoClass::GetObjectDescription メソッドをオーバーライドにするのに使用できます。

GetObjectDescription 関数は IComponentRegistrar::GetComponents によって呼び出されます。IComponentRegistrar は、1 つのダイナミック リンク ライブラリ (DLL: Dynamic-Link Library) 中の個別のコンポーネントを登録したり、登録解除できるようにするオートメーション インターフェイスです。ATL プロジェクト ウィザードを使用してコンポーネント レジストラ オブジェクトを作成すると、ウィザードは自動的に IComponentRegistrar インターフェイスを実装します。通常、IComponentRegistrar は Microsoft Transaction Server によって使用されます。

ATL プロジェクト ウィザードの詳細については、「ATL プロジェクトの作成」を参照してください。

使用例

class ATL_NO_VTABLE CMyDescribedClass :
   public CComObjectRoot,
   public CComCoClass<CMyDescribedClass, &CLSID_MyDescribedClass>
{
public:
   CMyDescribedClass()
   {
   }

   // Override CComCoClass::GetObjectDescription
   DECLARE_OBJECT_DESCRIPTION("My Described Object 1.0")
};

必要条件

ヘッダー : atlcom.h

参照

その他の技術情報

オブジェクト マップに関するマクロ

ATL マクロ