Export (0) Print
Expand All
ATL
Expand Minimize

DECLARE_OBJECT_DESCRIPTION 

Allows you to specify a text description for your class object.


DECLARE_OBJECT_DESCRIPTION( 
      x  
)

Parameters

x

[in] The class object's description.

ATL enters this description into the object map through the OBJECT_ENTRY macro.

DECLARE_OBJECT_DESCRIPTION implements a GetObjectDescription function, which you can use to override the CComCoClass::GetObjectDescription method.

The GetObjectDescription function is called by IComponentRegistrar::GetComponents. IComponentRegistrar is an Automation interface that allows you to register and unregister individual components in a DLL. When you create a Component Registrar object with the ATL Project Wizard, the wizard will automatically implement the IComponentRegistrar interface. IComponentRegistrar is typically used by Microsoft Transaction Server.

For more information about the ATL Project Wizard, see the article Creating an ATL Project.

class CMyClass : public CComCoClass< ... >, ...
{
public:
   // Override CComCoClass::GetObjectDescription
   DECLARE_OBJECT_DESCRIPTION("Account Transfer Object 1.0")

   ...
};

Community Additions

ADD
Show:
© 2014 Microsoft