CAtlModule-klasse

Opmerking

De ATL (Active Template Library) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

Deze klasse biedt methoden die worden gebruikt door verschillende ATL-moduleklassen.

Syntaxis

class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE

Leden

Openbare constructors

Naam	Description
CAtlModule::CAtlModule	De constructor.
CAtlModule::~CAtlModule	De destructor.

Openbare methoden

Naam	Description
CAtlModule::AddCommonRGSReplacements	Overschrijf deze methode om parameters toe te voegen aan de vervangingstoewijzing atL Registry Component (Registrar).
CAtlModule::AddTermFunc	Voegt een nieuwe functie toe die moet worden aangeroepen wanneer de module wordt beëindigd.
CAtlModule::GetGITPtr	Retourneert de Global Interface Pointer.
CAtlModule::GetLockCount	Retourneert het aantal vergrendelingen.
CAtlModule::Lock	Hiermee wordt het aantal vergrendelingen verhoogd.
CAtlModule::Term	Alle gegevensleden worden uitgebracht.
CAtlModule::Unlock	Hiermee wordt het aantal vergrendelingen afgerekend.
CAtlModule::UpdateRegistryFromResourceD	Voert het script uit dat is opgenomen in een opgegeven resource om een object te registreren of de registratie ervan ongedaan te maken.
CAtlModule::UpdateRegistryFromResourceDHelper	Deze methode wordt aangeroepen om UpdateRegistryFromResourceD de registerupdate uit te voeren.
CAtlModule::UpdateRegistryFromResourceS	Voert het script uit dat is opgenomen in een opgegeven resource om een object te registreren of de registratie ervan ongedaan te maken. Deze methode is statisch gekoppeld aan het ATL-registeronderdeel.

Publieke dataleden

Naam	Description
CAtlModule::m_libid	Bevat de GUID van de huidige module.
CAtlModule::m_pGIT	Aanwijzer naar de algemene interfacetabel.

Opmerkingen

Deze klasse wordt gebruikt door CAtlDllModuleT Class, CAtlExeModuleT Class en CAtlServiceModuleT Class om respectievelijk ondersteuning te bieden voor DLL-toepassingen, EXE-toepassingen en Windows-services.

Zie ATL-moduleklassen voor meer informatie over modules in ATL.

Deze klasse vervangt de verouderde CComModule-klasse die wordt gebruikt in eerdere versies van ATL.

Overnamehiërarchie

_ATL_MODULE

CAtlModule

Requirements

Header: atlbase.h

CAtlModule::AddCommonRGSReplacements

Overschrijf deze methode om parameters toe te voegen aan de vervangingstoewijzing atL Registry Component (Registrar).

virtual HRESULT AddCommonRGSReplacements(IRegistrarBase* /* pRegistrar*/) throw() = 0;

Parameterwaarden

pRegistrar
Gereserveerd.

Retourwaarde

Retourneert S_OK bij succes of een fout HRESULT bij fout.

Opmerkingen

Met vervangbare parameters kan de client van een registrar runtimegegevens opgeven. Hiervoor onderhoudt de registrar een vervangende kaart waarin deze de waarden invoert die zijn gekoppeld aan de vervangbare parameters in uw script. De registrar maakt deze vermeldingen tijdens runtime.

Zie het onderwerp Replaceable Parameters (De preprocessor van de registrar) gebruiken voor meer informatie.

CAtlModule::AddTermFunc

Voegt een nieuwe functie toe die moet worden aangeroepen wanneer de module wordt beëindigd.

HRESULT AddTermFunc(_ATL_TERMFUNC* pFunc, DWORD_PTR dw) throw();

Parameterwaarden

pFunc
Wijs de functie aan die u wilt toevoegen.

Dw
Door de gebruiker gedefinieerde gegevens, doorgegeven aan de functie.

Retourwaarde

Retourneert S_OK bij succes of een fout HRESULT bij fout.

CAtlModule::CAtlModule

De constructor.

CAtlModule() throw();

Opmerkingen

Initialiseert gegevensleden en initieert een kritieke sectie rond de thread van de module.

CAtlModule::~CAtlModule

De destructor.

~CAtlModule() throw();

Opmerkingen

Alle gegevensleden worden uitgebracht.

CAtlModule::GetGITPtr

Hiermee haalt u een aanwijzer op naar de algemene interfacetabel.

virtual HRESULT GetGITPtr(IGlobalInterfaceTable** ppGIT) throw();

Parameterwaarden

ppGIT
Aanwijzer naar de variabele die de aanwijzer naar de globale interfacetabel ontvangt.

Retourwaarde

Retourneert S_OK over geslaagd of een foutcode bij fouten. E_POINTER wordt geretourneerd als ppGIT gelijk is aan NULL.

Opmerkingen

Als het object Global Interface Table niet bestaat, wordt het gemaakt en wordt het adres opgeslagen in de lidvariabele CAtlModule::m_pGIT.

In builds voor foutopsporing treedt er een assertiefout op als ppGIT gelijk is aan NULL of als de pointer voor de algemene interfacetabel niet kan worden verkregen.

Zie IGlobalInterfaceTable voor informatie over de algemene interfacetabel.

CAtlModule::GetLockCount

Retourneert het aantal vergrendelingen.

virtual LONG GetLockCount() throw();

Retourwaarde

Retourneert het aantal vergrendelingen. Deze waarde kan nuttig zijn voor diagnostische gegevens en foutopsporing.

CAtlModule::Lock

Hiermee wordt het aantal vergrendelingen verhoogd.

virtual LONG Lock() throw();

Retourwaarde

Hiermee wordt het aantal vergrendelingen verhoogd en wordt de bijgewerkte waarde geretourneerd. Deze waarde kan nuttig zijn voor diagnostische gegevens en foutopsporing.

CAtlModule::m_libid

Bevat de GUID van de huidige module.

static GUID m_libid;

CAtlModule::m_pGIT

Aanwijzer naar de algemene interfacetabel.

IGlobalInterfaceTable* m_pGIT;

CAtlModule::Term

Alle gegevensleden worden uitgebracht.

void Term() throw();

Opmerkingen

Alle gegevensleden worden uitgebracht. Deze methode wordt aangeroepen door de destructor.

CAtlModule::Unlock

Hiermee wordt het aantal vergrendelingen afgerekend.

virtual LONG Unlock() throw();

Retourwaarde

Hiermee wordt het aantal vergrendelingen afgerekend en wordt de bijgewerkte waarde geretourneerd. Deze waarde kan nuttig zijn voor diagnostische gegevens en foutopsporing.

CAtlModule::UpdateRegistryFromResourceD

Voert het script uit dat is opgenomen in een opgegeven resource om een object te registreren of de registratie ervan ongedaan te maken.

HRESULT WINAPI UpdateRegistryFromResourceD(
    UINT nResID,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

HRESULT WINAPI UpdateRegistryFromResourceD(
    LPCTSTR lpszRes,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

Parameterwaarden

lpszRes
Een resourcenaam.

nResID
Een resource-id.

bRegister
WAAR als het object moet worden geregistreerd; ANDERS ONWAAR.

pMapEntries
Een aanwijzer naar de vervangende toewijzing die waarden opslaat die zijn gekoppeld aan de vervangbare parameters van het script. ATL maakt automatisch gebruik van %MODULE%. Zie CAtlModule::AddCommonRGSReplacements als u aanvullende vervangende parameters wilt gebruiken. Gebruik anders de standaardwaarde NULL.

Retourwaarde

Retourneert S_OK bij succes of een fout HRESULT bij fout.

Opmerkingen

Hiermee wordt het script uitgevoerd dat is opgenomen in de resource die is opgegeven door lpszRes of nResID. Als bRegister TRUE is, registreert deze methode het object in het systeemregister; anders wordt het object uit het register verwijderd.

Zie CAtlModule::UpdateRegistryFromResourceS als u statisch verbinding wilt maken met het ATL-registeronderdeel (registrar).

Met deze methode wordt CAtlModule::UpdateRegistryFromResourceDHelper en IRegistrar::ResourceUnregister aangeroepen.

CAtlModule::UpdateRegistryFromResourceDHelper

Deze methode wordt aangeroepen om UpdateRegistryFromResourceD de registerupdate uit te voeren.

inline HRESULT WINAPI UpdateRegistryFromResourceDHelper(
    LPCOLESTR lpszRes,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

Parameterwaarden

lpszRes
Een resourcenaam.

bRegister
Geeft aan of het object moet worden geregistreerd.

pMapEntries
Een aanwijzer naar de vervangende toewijzing die waarden opslaat die zijn gekoppeld aan de vervangbare parameters van het script. ATL maakt automatisch gebruik van %MODULE%. Zie CAtlModule::AddCommonRGSReplacements als u aanvullende vervangende parameters wilt gebruiken. Gebruik anders de standaardwaarde NULL.

Retourwaarde

Retourneert S_OK bij succes of een fout HRESULT bij fout.

Opmerkingen

Deze methode biedt de implementatie van CAtlModule::UpdateRegistryFromResourceD.

CAtlModule::UpdateRegistryFromResourceS

Voert het script uit dat is opgenomen in een opgegeven resource om een object te registreren of de registratie ervan ongedaan te maken. Deze methode is statisch gekoppeld aan het ATL-registeronderdeel.

HRESULT WINAPI UpdateRegistryFromResourceS(
    UINT nResID,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

HRESULT WINAPI UpdateRegistryFromResourceS(
    LPCTSTR lpszRes,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

Parameterwaarden

nResID
Een resource-id.

lpszRes
Een resourcenaam.

bRegister
Geeft aan of het resourcescript moet worden geregistreerd.

pMapEntries
Een aanwijzer naar de vervangende toewijzing die waarden opslaat die zijn gekoppeld aan de vervangbare parameters van het script. ATL maakt automatisch gebruik van %MODULE%. Zie CAtlModule::AddCommonRGSReplacements als u aanvullende vervangende parameters wilt gebruiken. Gebruik anders de standaardwaarde NULL.

Retourwaarde

Retourneert S_OK bij succes of een fout HRESULT bij fout.

Opmerkingen

Vergelijkbaar met CAtlModule::UpdateRegistryFromResourceD behalve CAtlModule::UpdateRegistryFromResourceS maakt u een statische koppeling naar het ATL-registeronderdeel (registrar).

Zie ook

_ATL_MODULE
Overzicht van klassen
Moduleklassen
Registeronderdeel (registrar)