CAtlModule, classe

Cette classe fournit des méthodes utilisées par plusieurs classes de module ATL.

Syntaxe

class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE

Membres

Constructeurs publics

Nom	Description
CAtlModule ::CAtlModule	Constructeur .
CAtlModule ::~CAtlModule	Destructeur.

Méthodes publiques

Nom	Description
CAtlModule ::AddCommonRGSReplacements	Remplacez cette méthode pour ajouter des paramètres au mappage de remplacement du composant de Registre ATL (Bureau d’enregistrement).
CAtlModule ::AddTermFunc	Ajoute une nouvelle fonction à appeler lorsque le module se termine.
CAtlModule ::GetGITPtr	Retourne le pointeur de l’interface globale.
CAtlModule ::GetLockCount	Retourne le nombre de verrous.
CAtlModule ::Lock	Incrémente le nombre de verrous.
CAtlModule ::Term	Libère tous les membres de données.
CAtlModule ::Unlock	Décrémente le nombre de verrous.
CAtlModule ::UpdateRegistryFromResourceD	Exécute le script contenu dans une ressource spécifiée pour inscrire ou annuler l’inscription d’un objet.
CAtlModule ::UpdateRegistryFromResourceDHelper	Cette méthode est appelée pour UpdateRegistryFromResourceD effectuer la mise à jour du Registre.
CAtlModule ::UpdateRegistryFromResourceS	Exécute le script contenu dans une ressource spécifiée pour inscrire ou annuler l’inscription d’un objet. Cette méthode est liée statiquement au composant de Registre ATL.

Membres de données publics

Nom	Description
CAtlModule ::m_libid	Contient le GUID du module actuel.
CAtlModule ::m_pGIT	Pointeur vers la table d’interface globale.

Notes

Cette classe est utilisée par la classe CAtlDllModuleT, la classe CAtlExeModuleT et la classe CAtlServiceModuleT afin de prendre en charge les applications DLL, les applications EXE et les services Windows, respectivement.

Pour plus d’informations sur les modules dans ATL, consultez les classes de module ATL.

Cette classe remplace la classe CComModule obsolète utilisée dans les versions antérieures d’ATL.

Hiérarchie d'héritage

_ATL_MODULE

CAtlModule

Spécifications

En-tête : atlbase.h

CAtlModule ::AddCommonRGSReplacements

Remplacez cette méthode pour ajouter des paramètres au mappage de remplacement du composant de Registre ATL (Bureau d’enregistrement).

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

Paramètres

pRegistrar
Réservé.

Valeur de retour

Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.

Notes

Les paramètres remplaçables permettent au client d’un bureau d’enregistrement de spécifier des données d’exécution. Pour ce faire, le bureau d’enregistrement conserve une carte de remplacement dans laquelle elle entre les valeurs associées aux paramètres remplaçables dans votre script. Le bureau d’enregistrement effectue ces entrées au moment de l’exécution.

Pour plus d’informations, consultez la rubrique Utilisation des paramètres remplaçables (préprocesseur du bureau d’enregistrement).

CAtlModule ::AddTermFunc

Ajoute une nouvelle fonction à appeler lorsque le module se termine.

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

Paramètres

pFunc
Pointeur vers la fonction à ajouter.

dw
Données définies par l’utilisateur, transmises à la fonction.

Valeur de retour

Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.

CAtlModule ::CAtlModule

Constructeur .

CAtlModule() throw();

Notes

Initialise les membres de données et lance une section critique autour du thread du module.

CAtlModule ::~CAtlModule

Destructeur.

~CAtlModule() throw();

Notes

Libère tous les membres de données.

CAtlModule ::GetGITPtr

Récupère un pointeur vers la table d’interface globale.

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

Paramètres

ppGIT
Pointeur vers la variable qui recevra le pointeur vers la table d’interface globale.

Valeur de retour

Retourne S_OK en cas de réussite ou un code d’erreur en cas d’échec. E_POINTER est retourné si ppGIT est égal à NULL.

Notes

Si l’objet Table d’interface globale n’existe pas, il est créé et son adresse est stockée dans la variable membre CAtlModule ::m_pGIT.

Dans les builds de débogage, une erreur d’assertion se produit si ppGIT est égal à NULL ou si le pointeur de la table d’interface globale ne peut pas être obtenu.

Pour plus d’informations sur la table d’interface globale, consultez IGlobalInterfaceTable .

CAtlModule ::GetLockCount

Retourne le nombre de verrous.

virtual LONG GetLockCount() throw();

Valeur de retour

Retourne le nombre de verrous. Cette valeur peut être utile pour les diagnostics et le débogage.

CAtlModule ::Lock

Incrémente le nombre de verrous.

virtual LONG Lock() throw();

Valeur de retour

Incrémente le nombre de verrous et retourne la valeur mise à jour. Cette valeur peut être utile pour les diagnostics et le débogage.

CAtlModule ::m_libid

Contient le GUID du module actuel.

static GUID m_libid;

CAtlModule ::m_pGIT

Pointeur vers la table d’interface globale.

IGlobalInterfaceTable* m_pGIT;

CAtlModule ::Term

Libère tous les membres de données.

void Term() throw();

Notes

Libère tous les membres de données. Cette méthode est appelée par le destructeur.

CAtlModule ::Unlock

Décrémente le nombre de verrous.

virtual LONG Unlock() throw();

Valeur de retour

Décrémente le nombre de verrous et retourne la valeur mise à jour. Cette valeur peut être utile pour les diagnostics et le débogage.

CAtlModule ::UpdateRegistryFromResourceD

Exécute le script contenu dans une ressource spécifiée pour inscrire ou annuler l’inscription d’un objet.

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();

Paramètres

lpszRes
Nom de la ressource.

nResID
ID de ressource.

bRegister
TRUE si l’objet doit être inscrit ; FALSE dans le cas contraire.

pMapEntries
Pointeur vers la carte de remplacement stockant les valeurs associées aux paramètres remplaçables du script. ATL utilise automatiquement %MODULE%. Pour utiliser des paramètres remplaçables supplémentaires, consultez CAtlModule ::AddCommonRGSReplacements. Sinon, utilisez la valeur null par défaut.

Valeur de retour

Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.

Notes

Exécute le script contenu dans la ressource spécifiée par lpszRes ou nResID. Si bRegister a la valeur TRUE, cette méthode inscrit l’objet dans le registre système ; sinon, il supprime l’objet du Registre.

Pour établir un lien statique vers le composant de Registre ATL (Bureau d’enregistrement), consultez CAtlModule ::UpdateRegistryFromResourceS.

Cette méthode appelle CAtlModule ::UpdateRegistryFromResourceDHelper et IRegistrar ::ResourceUnregister.

CAtlModule ::UpdateRegistryFromResourceDHelper

Cette méthode est appelée pour UpdateRegistryFromResourceD effectuer la mise à jour du Registre.

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

Paramètres

lpszRes
Nom de la ressource.

bRegister
Indique si l’objet doit être inscrit.

pMapEntries
Pointeur vers la carte de remplacement stockant les valeurs associées aux paramètres remplaçables du script. ATL utilise automatiquement %MODULE%. Pour utiliser des paramètres remplaçables supplémentaires, consultez CAtlModule ::AddCommonRGSReplacements. Sinon, utilisez la valeur null par défaut.

Valeur de retour

Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.

Notes

Cette méthode fournit l’implémentation de CAtlModule ::UpdateRegistryFromResourceD.

CAtlModule ::UpdateRegistryFromResourceS

Exécute le script contenu dans une ressource spécifiée pour inscrire ou annuler l’inscription d’un objet. Cette méthode est liée statiquement au composant de Registre 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();

Paramètres

nResID
ID de ressource.

lpszRes
Nom de la ressource.

bRegister
Indique si le script de ressource doit être inscrit.

pMapEntries
Pointeur vers la carte de remplacement stockant les valeurs associées aux paramètres remplaçables du script. ATL utilise automatiquement %MODULE%. Pour utiliser des paramètres remplaçables supplémentaires, consultez CAtlModule ::AddCommonRGSReplacements. Sinon, utilisez la valeur null par défaut.

Valeur de retour

Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.

Notes

Similaire à CAtlModule ::UpdateRegistryFromResourceD , à l’exception de la création CAtlModule::UpdateRegistryFromResourceS d’un lien statique vers le composant de Registre ATL (Bureau d’enregistrement).

Voir aussi

_ATL_MODULE
Vue d’ensemble de la classe
Module Classes
Composant du Registre (enregistreur)