CAtlModule – třída
Tato třída poskytuje metody používané několika třídami modulů ATL.
Syntaxe
class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE
Členové
Veřejné konstruktory
| Název | Popis |
|---|---|
| CAtlModule::CAtlModule | Konstruktor |
| CAtlModule::~CAtlModule | Destruktor. |
Veřejné metody
| Název | Popis |
|---|---|
| CAtlModule::AddCommonRGSReplacements | Tuto metodu přepište, pokud chcete přidat parametry do náhradní mapy komponenty REGISTRU ATL (Registrátor). |
| CAtlModule::AddTermFunc | Přidá novou funkci, která se má volat při ukončení modulu. |
| CAtlModule::GetGITPtr | Vrátí ukazatel globálního rozhraní. |
| CAtlModule::GetLockCount | Vrátí počet zámků. |
| CAtlModule::Lock | Zvýší počet zámků. |
| CAtlModule::Term | Uvolní všechny datové členy. |
| CAtlModule::Unlock | Sníží počet zámků. |
| CAtlModule::UpdateRegistryFromResourceD | Spustí skript obsažený v zadaném prostředku pro registraci nebo zrušení registrace objektu. |
| CAtlModule::UpdateRegistryFromResourceDHelper | Tato metoda je volána UpdateRegistryFromResourceD k provedení aktualizace registru. |
| CAtlModule::UpdateRegistryFromResourceS | Spustí skript obsažený v zadaném prostředku pro registraci nebo zrušení registrace objektu. Tato metoda staticky odkazuje na komponentu registru ATL. |
Veřejné datové členy
| Název | Popis |
|---|---|
| CAtlModule::m_libid | Obsahuje identifikátor GUID aktuálního modulu. |
| CAtlModule::m_pGIT | Ukazatel na tabulku globálního rozhraní |
Poznámky
Tuto třídu používá CAtlDllModuleT – třída, CAtlExeModuleT – třída a CAtlServiceModuleT – třída k poskytování podpory aplikací DLL, aplikací EXE a služeb systému Windows.
Další informace o modulech v ATL najdete v tématu Třídy modulů ATL.
Tato třída nahrazuje zastaralou třídu CComModule použitou v dřívějších verzích KNIHOVNY ATL.
Hierarchie dědičnosti
CAtlModule
Požadavky
Hlavička: atlbase.h
CAtlModule::AddCommonRGSReplacements
Tuto metodu přepište, pokud chcete přidat parametry do náhradní mapy komponenty REGISTRU ATL (Registrátor).
virtual HRESULT AddCommonRGSReplacements(IRegistrarBase* /* pRegistrar*/) throw() = 0;
Parametry
pRegistrar
Vyhrazeno.
Návratová hodnota
Vrátí S_OK při úspěchu nebo chybu HRESULT při selhání.
Poznámky
Nahraditelné parametry umožňují klientovi registrátora zadat data za běhu. Za tímto účelem registrátor udržuje náhradní mapu, do které zadá hodnoty přidružené k nahraditelným parametrům ve vašem skriptu. Registrátor tyto položky provede za běhu.
Další podrobnosti najdete v tématu Použití nahraditelných parametrů (preprocesor registrátora).
CAtlModule::AddTermFunc
Přidá novou funkci, která se má volat při ukončení modulu.
HRESULT AddTermFunc(_ATL_TERMFUNC* pFunc, DWORD_PTR dw) throw();
Parametry
pFunc
Ukazatel na funkci, která se má přidat.
Dw
Uživatelem definovaná data předaná funkci.
Návratová hodnota
Vrátí S_OK při úspěchu nebo chybu HRESULT při selhání.
CAtlModule::CAtlModule
Konstruktor
CAtlModule() throw();
Poznámky
Inicializuje datové členy a zahájí kritickou část kolem vlákna modulu.
CAtlModule::~CAtlModule
Destruktor.
~CAtlModule() throw();
Poznámky
Uvolní všechny datové členy.
CAtlModule::GetGITPtr
Načte ukazatel na tabulku globálního rozhraní.
virtual HRESULT GetGITPtr(IGlobalInterfaceTable** ppGIT) throw();
Parametry
ppGIT
Ukazatel na proměnnou, která obdrží ukazatel na tabulku globálního rozhraní.
Návratová hodnota
Vrátí S_OK při úspěchu nebo kód chyby při selhání. E_POINTER je vrácena, pokud je hodnota ppGIT rovna hodnotě NULL.
Poznámky
Pokud objekt Global Interface Table neexistuje, je vytvořen a jeho adresa je uložena v členské proměnné CAtlModule::m_pGIT.
V sestavení ladění dojde k chybě kontrolního výrazu v případě, že ppGIT je rovna hodnotě NULL nebo pokud nelze získat ukazatel tabulky globálního rozhraní.
Informace o tabulce globálního rozhraní najdete v tabulce IGlobalInterfaceTable .
CAtlModule::GetLockCount
Vrátí počet zámků.
virtual LONG GetLockCount() throw();
Návratová hodnota
Vrátí počet zámků. Tato hodnota může být užitečná pro diagnostiku a ladění.
CAtlModule::Lock
Zvýší počet zámků.
virtual LONG Lock() throw();
Návratová hodnota
Zvýší počet zámků a vrátí aktualizovanou hodnotu. Tato hodnota může být užitečná pro diagnostiku a ladění.
CAtlModule::m_libid
Obsahuje identifikátor GUID aktuálního modulu.
static GUID m_libid;
CAtlModule::m_pGIT
Ukazatel na tabulku globálního rozhraní
IGlobalInterfaceTable* m_pGIT;
CAtlModule::Term
Uvolní všechny datové členy.
void Term() throw();
Poznámky
Uvolní všechny datové členy. Tato metoda je volána destruktoru.
CAtlModule::Unlock
Sníží počet zámků.
virtual LONG Unlock() throw();
Návratová hodnota
Sníží počet zámků a vrátí aktualizovanou hodnotu. Tato hodnota může být užitečná pro diagnostiku a ladění.
CAtlModule::UpdateRegistryFromResourceD
Spustí skript obsažený v zadaném prostředku pro registraci nebo zrušení registrace objektu.
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();
Parametry
lpszRes
Název prostředku.
nResID
ID prostředku.
bRegister
TRUE, pokud by měl být objekt registrován; JINAK NEPRAVDA.
pMapEntries
Ukazatel na náhradní mapování ukládá hodnoty přidružené k nahraditelným parametrům skriptu. ATL automaticky používá %MODULE%. Pokud chcete použít další nahraditelné parametry, přečtěte si téma CAtlModule::AddCommonRGSReplacements. V opačném případě použijte výchozí hodnotu NULL.
Návratová hodnota
Vrátí S_OK při úspěchu nebo chybu HRESULT při selhání.
Poznámky
Spustí skript obsažený v prostředku určeném lpszRes nebo nResID. Pokud bRegister je TRUE, tato metoda registruje objekt v systémovém registru; jinak odebere objekt z registru.
Pokud chcete staticky propojit komponentu registru ATL (registrátora), přečtěte si téma CAtlModule::UpdateRegistryFromResourceS.
Tato metoda volá CAtlModule::UpdateRegistryFromResourceDHelper a IRegistrar::ResourceUnregister.
CAtlModule::UpdateRegistryFromResourceDHelper
Tato metoda je volána UpdateRegistryFromResourceD k provedení aktualizace registru.
inline HRESULT WINAPI UpdateRegistryFromResourceDHelper(
LPCOLESTR lpszRes,
BOOL bRegister,
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();
Parametry
lpszRes
Název prostředku.
bRegister
Určuje, zda má být objekt registrován.
pMapEntries
Ukazatel na náhradní mapování ukládá hodnoty přidružené k nahraditelným parametrům skriptu. ATL automaticky používá %MODULE%. Pokud chcete použít další nahraditelné parametry, přečtěte si téma CAtlModule::AddCommonRGSReplacements. V opačném případě použijte výchozí hodnotu NULL.
Návratová hodnota
Vrátí S_OK při úspěchu nebo chybu HRESULT při selhání.
Poznámky
Tato metoda poskytuje implementaci CAtlModule::UpdateRegistryFromResourceD.
CAtlModule::UpdateRegistryFromResourceS
Spustí skript obsažený v zadaném prostředku pro registraci nebo zrušení registrace objektu. Tato metoda staticky odkazuje na komponentu registru ATL.
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();
Parametry
nResID
ID prostředku.
lpszRes
Název prostředku.
bRegister
Určuje, zda má být skript prostředku registrován.
pMapEntries
Ukazatel na náhradní mapování ukládá hodnoty přidružené k nahraditelným parametrům skriptu. ATL automaticky používá %MODULE%. Pokud chcete použít další nahraditelné parametry, přečtěte si téma CAtlModule::AddCommonRGSReplacements. V opačném případě použijte výchozí hodnotu NULL.
Návratová hodnota
Vrátí S_OK při úspěchu nebo chybu HRESULT při selhání.
Poznámky
Podobá se CAtlModule::UpdateRegistryFromResourceD s výjimkou CAtlModule::UpdateRegistryFromResourceS vytvoření statického odkazu na komponentu registru ATL (registrátor).
Viz také
_ATL_MODULE
Přehled třídy
Třídy modulů
Součást registru (registrátor)