Partilhar via

Classe CAtlModule

  • Artigo

Essa classe fornece métodos usados por várias classes de módulo da ATL.

Sintaxe

class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE

Membros

Construtores públicos

Nome Descrição
CAtlModule::CAtlModule O construtor .
CAtlModule::~CAtlModule O destruidor.

Métodos públicos

Nome Descrição
CAtlModule::AddCommonRGSReplacements Substitua esse método para adicionar parâmetros ao mapa de substituição do Componente do Registro da ATL (Registrador).
CAtlModule::AddTermFunc Adiciona uma nova função a ser chamada quando o módulo é encerrado.
CAtlModule::GetGITPtr Retorna o Ponteiro de Interface Global.
CAtlModule::GetLockCount Retorna a contagem de bloqueios.
CAtlModule::Lock Incrementa a contagem de bloqueios.
CAtlModule::Term Libera todos os membros de dados.
CAtlModule::Unlock Diminui a contagem de bloqueio.
CAtlModule::UpdateRegistryFromResourceD Executa o script contido em um recurso especificado para registrar ou cancelar o registro de um objeto.
CAtlModule::UpdateRegistryFromResourceDHelper Esse método é chamado por UpdateRegistryFromResourceD para executar a atualização do Registro.
CAtlModule::UpdateRegistryFromResourceS Executa o script contido em um recurso especificado para registrar ou cancelar o registro de um objeto. Esse método é vinculado estaticamente ao Componente do Registro da ATL.

Membros de Dados Públicos

Nome Descrição
CAtlModule::m_libid Contém o GUID do módulo atual.
CAtlModule::m_pGIT Ponteiro para a tabela de interface global.

Comentários

Essa classe é usada pelas classes CAtlDllModuleT, CAtlExeModuleT e CAtlServiceModuleT para fornecer suporte a aplicativos DLL, aplicativos EXE e serviços Windows, respectivamente.

Para obter mais informações sobre módulos na ATL, consulte Classes de módulo da ATL.

Essa classe substitui a classe obsoleta CComModule usada em versões anteriores da ATL.

Hierarquia de herança

_ATL_MODULE

CAtlModule

Requisitos

Cabeçalho: atlbase.h

CAtlModule::AddCommonRGSReplacements

Substitua esse método para adicionar parâmetros ao mapa de substituição do Componente do Registro da ATL (Registrador).

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

Parâmetros

pRegistrar
Reservado.

Valor de retorno

Retornará S_OK se houver êxito ou um erro HRESULT, em caso de falha.

Comentários

Os parâmetros substituíveis permitem que o cliente do Registrador especifique dados em tempo de execução. Para fazer isso, o Registrador mantém um mapa de substituição no qual insere os valores associados aos parâmetros substituíveis em seu script. O Registrador faz essas entradas no tempo de execução.

Confira o tópico Usar parâmetros substituíveis (o pré-processador do Registrador) para obter mais detalhes.

CAtlModule::AddTermFunc

Adiciona uma nova função a ser chamada quando o módulo é encerrado.

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

Parâmetros

pFunc
Ponteiro para a função a ser adicionada.

dw
Dados definidos pelo usuário, passados para a função.

Valor de retorno

Retornará S_OK se houver êxito ou um erro HRESULT, em caso de falha.

CAtlModule::CAtlModule

O construtor .

CAtlModule() throw();

Comentários

Inicializa os membros de dados e inicia uma seção crítica em torno do thread do módulo.

CAtlModule::~CAtlModule

O destruidor.

~CAtlModule() throw();

Comentários

Libera todos os membros de dados.

CAtlModule::GetGITPtr

Recupera um ponteiro para a tabela de interface global.

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

Parâmetros

ppGIT
Ponteiro para a variável que receberá o ponteiro para a tabela de interface global.

Valor de retorno

Retornará S_OK se houver êxito ou um código de erro em caso de falha. E_POINTER será retornado se ppGIT for igual a NULL.

Comentários

Se o objeto Tabela de interface global não existir, ele será criado e seu endereço será armazenado na variável de membro CAtlModule::m_pGIT.

Em builds de depuração, ocorrerá um erro de declaração se ppGIT for igual a NULL ou se o ponteiro Tabela de interface global não puder ser obtido.

Consulte IGlobalInterfaceTable para obter informações sobre a tabela de interface global.

CAtlModule::GetLockCount

Retorna a contagem de bloqueios.

virtual LONG GetLockCount() throw();

Valor de retorno

Retorna a contagem de bloqueios. Esse valor pode ser útil para diagnóstico e depuração.

CAtlModule::Lock

Incrementa a contagem de bloqueios.

virtual LONG Lock() throw();

Valor de retorno

Incrementa a contagem de bloqueios e retorna o valor atualizado. Esse valor pode ser útil para diagnóstico e depuração.

CAtlModule::m_libid

Contém o GUID do módulo atual.

static GUID m_libid;

CAtlModule::m_pGIT

Ponteiro para a tabela de interface global.

IGlobalInterfaceTable* m_pGIT;

CAtlModule::Term

Libera todos os membros de dados.

void Term() throw();

Comentários

Libera todos os membros de dados. Esse método é chamado pelo destruidor.

CAtlModule::Unlock

Diminui a contagem de bloqueio.

virtual LONG Unlock() throw();

Valor de retorno

Diminui a contagem de bloqueios e retorna o valor atualizado. Esse valor pode ser útil para diagnóstico e depuração.

CAtlModule::UpdateRegistryFromResourceD

Executa o script contido em um recurso especificado para registrar ou cancelar o registro de um 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
Um nome do recurso.

nResID
Uma ID do recurso.

bRegister
TRUE se o objeto deve ser registrado; FALSE caso contrário.

pMapEntries
Um ponteiro para o mapa de substituição armazenando valores associados aos parâmetros substituíveis do script. A ATL usa automaticamente %MODULE%. Para usar parâmetros substituíveis adicionais, confira CAtlModule::AddCommonRGSReplacements. Caso contrário, use o valor padrão NULL.

Valor de retorno

Retornará S_OK se houver êxito ou um erro HRESULT, em caso de falha.

Comentários

Executa o script contido no recurso especificado por lpszRes ou nResID. Se bRegister for TRUE, esse método registrará o objeto no Registro do sistema. Caso contrário, ele removerá o objeto do Registro.

Para ser vinculado estaticamente ao Componente do Registro da ATL (Registrador), confira CAtlModule::UpdateRegistryFromResourceS.

Esse método chama CAtlModule::UpdateRegistryFromResourceDHelper e IRegistrar::ResourceUnregister.

CAtlModule::UpdateRegistryFromResourceDHelper

Esse método é chamado por UpdateRegistryFromResourceD para executar a atualização do Registro.

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

Parâmetros

lpszRes
Um nome do recurso.

bRegister
Indica se o objeto deve ser registrado.

pMapEntries
Um ponteiro para o mapa de substituição armazenando valores associados aos parâmetros substituíveis do script. A ATL usa automaticamente %MODULE%. Para usar parâmetros substituíveis adicionais, confira CAtlModule::AddCommonRGSReplacements. Caso contrário, use o valor padrão NULL.

Valor de retorno

Retornará S_OK se houver êxito ou um erro HRESULT, em caso de falha.

Comentários

Esse método fornece a implementação de CAtlModule::UpdateRegistryFromResourceD.

CAtlModule::UpdateRegistryFromResourceS

Executa o script contido em um recurso especificado para registrar ou cancelar o registro de um objeto. Esse método é vinculado estaticamente ao Componente do Registro da 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
Uma ID do recurso.

lpszRes
Um nome do recurso.

bRegister
Indica se o script de recurso deve ser registrado.

pMapEntries
Um ponteiro para o mapa de substituição armazenando valores associados aos parâmetros substituíveis do script. A ATL usa automaticamente %MODULE%. Para usar parâmetros substituíveis adicionais, confira CAtlModule::AddCommonRGSReplacements. Caso contrário, use o valor padrão NULL.

Valor de retorno

Retornará S_OK se houver êxito ou um erro HRESULT, em caso de falha.

Comentários

Semelhante a CAtlModule::UpdateRegistryFromResourceD, exceto que CAtlModule::UpdateRegistryFromResourceS cria um link estático para o Componente do Registro da ATL (Registrador).

Confira também

_ATL_MODULE
Visão geral da aula
Classes de módulo
Componente de Registro (Registrador)