CComCoClass::GetObjectDescription
This static function retrieves the text description for your class object.
Syntax
static LPCTSTR WINAPI GetObjectDescription( );
Return Value
The class object's description.
Remarks
The default implementation returns NULL. You can override this method with the DECLARE_OBJECT_DESCRIPTION macro. For example:
class ATL_NO_VTABLE CMyDoc :
public CComObjectRootEx<CComSingleThreadModel>,
public CComCoClass<CMyDoc, &CLSID_MyDoc>,
public IDocument
{
public:
DECLARE_OBJECT_DESCRIPTION("My Document Object 1.0")
// Remainder of class declaration omitted.
GetObjectDescription 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.
Requirements
Header: atlcom.h