CAtlModule (clase)
Esta clase proporciona métodos usados por varias clases de módulo ATL.
Sintaxis
class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE
Miembros
Constructores públicos
| Nombre | Descripción |
|---|---|
| CAtlModule::CAtlModule | Constructor . |
| CAtlModule::~CAtlModule | El destructor . |
Métodos públicos
| Nombre | Descripción |
|---|---|
| CAtlModule::AddCommonRGSReplacements | Invalide este método para agregar parámetros a la asignación de reemplazo componente del registro ATL (registrador). |
| CAtlModule::AddTermFunc | Agrega una nueva función a la que se llamará cuando finalice el módulo. |
| CAtlModule::GetGITPtr | Devuelve el puntero de interfaz global. |
| CAtlModule::GetLockCount | Devuelve el recuento de bloqueos. |
| CAtlModule::Lock | Incrementa el recuento de bloqueos. |
| CAtlModule::Term | Libera todos los miembros de datos. |
| CAtlModule::Unlock | Reduce el recuento de bloqueos. |
| CAtlModule::UpdateRegistryFromResourceD | Ejecuta el script contenido en un recurso especificado para registrar o anular el registro de un objeto. |
| CAtlModule::UpdateRegistryFromResourceDHelper | UpdateRegistryFromResourceD llama a este método para realizar la actualización del registro. |
| CAtlModule::UpdateRegistryFromResourceS | Ejecuta el script contenido en un recurso especificado para registrar o anular el registro de un objeto. Este método se vincula estáticamente al componente del registro ATL. |
Miembros de datos públicos
| Nombre | Descripción |
|---|---|
| CAtlModule::m_libid | Contiene el GUID del módulo actual. |
| CAtlModule::m_pGIT | Puntero a la tabla de interfaz global. |
Comentarios
Esta clase la usa CAtlDllModuleT Class, CAtlExeModuleT Class y CAtlServiceModuleT Class para proporcionar compatibilidad con aplicaciones DLL, aplicaciones EXE y servicios de Windows, respectivamente.
Para obtener más información sobre los módulos de ATL, consulte Clases de módulo de ATL.
Esta clase reemplaza a la clase CComModule obsoleta usada en versiones anteriores de ATL.
Jerarquía de herencia
CAtlModule
Requisitos
Encabezado: atlbase.h
CAtlModule::AddCommonRGSReplacements
Invalide este método para agregar parámetros a la asignación de reemplazo componente del registro ATL (registrador).
virtual HRESULT AddCommonRGSReplacements(IRegistrarBase* /* pRegistrar*/) throw() = 0;
Parámetros
pRegistrar
Reservado.
Valor devuelto
Devuelve S_OK si es correcto o un error HRESULT en caso de error.
Comentarios
Mediante los parámetros reemplazables el cliente de un registrador puede especificar datos en tiempo de ejecución. Para ello, el registrador mantiene una asignación de reemplazo en la que escribe los valores asociados a los parámetros reemplazables en el script. El registrador realiza estas entradas en tiempo de ejecución.
Consulte el tema Uso de parámetros reemplazables ( el preprocesador del registrador) para más información.
CAtlModule::AddTermFunc
Agrega una nueva función a la que se llamará cuando finalice el módulo.
HRESULT AddTermFunc(_ATL_TERMFUNC* pFunc, DWORD_PTR dw) throw();
Parámetros
pFunc
Puntero a la función que se va a agregar.
dw
Datos definidos por el usuario, pasados a la función.
Valor devuelto
Devuelve S_OK si es correcto o un error HRESULT en caso de error.
CAtlModule::CAtlModule
Constructor .
CAtlModule() throw();
Comentarios
Inicializa los miembros de datos e inicia una sección crítica en torno al subproceso del módulo.
CAtlModule::~CAtlModule
El destructor .
~CAtlModule() throw();
Comentarios
Libera todos los miembros de datos.
CAtlModule::GetGITPtr
Recupera un puntero a la tabla de interfaz global.
virtual HRESULT GetGITPtr(IGlobalInterfaceTable** ppGIT) throw();
Parámetros
ppGIT
Puntero a la variable que recibirá el puntero a la tabla de interfaz global.
Valor devuelto
Devuelve S_OK si se ejecuta correctamente, o un código de error COM en caso contrario. E_POINTER se devuelve si ppGIT es igual a null.
Comentarios
Si el objeto de tabla de interfaz global no existe, se crea y su dirección se almacena en la variable miembro CAtlModule::m_pGIT.
En las compilaciones de depuración, se producirá un error de aserción si ppGIT es igual a null o si no se puede obtener el puntero de tabla de interfaz global.
Consulte IGlobalInterfaceTable para obtener información sobre la tabla de interfaz global.
CAtlModule::GetLockCount
Devuelve el recuento de bloqueos.
virtual LONG GetLockCount() throw();
Valor devuelto
Devuelve el recuento de bloqueos. Este valor puede ser útil para el diagnóstico y la depuración.
CAtlModule::Lock
Incrementa el recuento de bloqueos.
virtual LONG Lock() throw();
Valor devuelto
Incrementa el recuento de bloqueos y devuelve el valor actualizado. Este valor puede ser útil para el diagnóstico y la depuración.
CAtlModule::m_libid
Contiene el GUID del módulo actual.
static GUID m_libid;
CAtlModule::m_pGIT
Puntero a la tabla de interfaz global.
IGlobalInterfaceTable* m_pGIT;
CAtlModule::Term
Libera todos los miembros de datos.
void Term() throw();
Comentarios
Libera todos los miembros de datos. El destructor llama a este método.
CAtlModule::Unlock
Reduce el recuento de bloqueos.
virtual LONG Unlock() throw();
Valor devuelto
Disminuye el recuento de bloqueos y devuelve el valor actualizado. Este valor puede ser útil para el diagnóstico y la depuración.
CAtlModule::UpdateRegistryFromResourceD
Ejecuta el script contenido en un recurso especificado para registrar o anular el registro de un objeto.
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();
Parámetros
lpszRes
Un nombre de recurso.
nResID
Identificador de recurso.
bRegister
TRUE si se debe registrar el objeto; FALSE en caso contrario.
pMapEntries
Puntero al mapa de reemplazo que almacena los valores asociados a los parámetros reemplazables del script. ATL usa automáticamente %MODULE%. Para usar parámetros reemplazables adicionales, consulte CAtlModule::AddCommonRGSReplacements. De lo contrario, use el valor predeterminado NULL.
Valor devuelto
Devuelve S_OK si es correcto o un error HRESULT en caso de error.
Comentarios
Ejecuta el script contenido en el recurso especificado por lpszRes o nResID. Si bRegister es TRUE, este método registra el objeto en el registro del sistema; de lo contrario, quita el objeto del registro.
Para vincular estáticamente al componente del registro ATL (Registrador), consulte CAtlModule::UpdateRegistryFromResourceS.
Este método llama a CAtlModule::UpdateRegistryFromResourceDHelper e IRegistrar::ResourceUnregister.
CAtlModule::UpdateRegistryFromResourceDHelper
UpdateRegistryFromResourceD llama a este método para realizar la actualización del registro.
inline HRESULT WINAPI UpdateRegistryFromResourceDHelper(
LPCOLESTR lpszRes,
BOOL bRegister,
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();
Parámetros
lpszRes
Un nombre de recurso.
bRegister
Indica si se debe registrar el objeto.
pMapEntries
Puntero al mapa de reemplazo que almacena los valores asociados a los parámetros reemplazables del script. ATL usa automáticamente %MODULE%. Para usar parámetros reemplazables adicionales, consulte CAtlModule::AddCommonRGSReplacements. De lo contrario, use el valor predeterminado NULL.
Valor devuelto
Devuelve S_OK si es correcto o un error HRESULT en caso de error.
Comentarios
Este método proporciona la implementación de CAtlModule::UpdateRegistryFromResourceD.
CAtlModule::UpdateRegistryFromResourceS
Ejecuta el script contenido en un recurso especificado para registrar o anular el registro de un objeto. Este método se vincula estáticamente al componente del registro 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();
Parámetros
nResID
Identificador de recurso.
lpszRes
Un nombre de recurso.
bRegister
Indica si se debe registrar el script de recursos.
pMapEntries
Puntero al mapa de reemplazo que almacena los valores asociados a los parámetros reemplazables del script. ATL usa automáticamente %MODULE%. Para usar parámetros reemplazables adicionales, consulte CAtlModule::AddCommonRGSReplacements. De lo contrario, use el valor predeterminado NULL.
Valor devuelto
Devuelve S_OK si es correcto o un error HRESULT en caso de error.
Comentarios
De forma similar a CAtlModule::UpdateRegistryFromResourceD, excepto CAtlModule::UpdateRegistryFromResourceS, crea un vínculo estático al componente del registro ATL (registrador).
Consulte también
_ATL_MODULE
Información general sobre la clase
Clases de módulo
Componente de registro (Registrador)