Bagikan melalui

Kelas CAtlModule

  • Artikel

Kelas ini menyediakan metode yang digunakan oleh beberapa kelas modul ATL.

Sintaks

class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE

Anggota

Konstruktor Publik

Nama Deskripsi
CAtlModule::CAtlModule Konstruktor.
CAtlModule::~CAtlModule Destruktor.

Metode Publik

Nama Deskripsi
CAtlModule::AddCommonRGSReplacements Ambil alih metode ini untuk menambahkan parameter ke peta penggantian Komponen Registri ATL (Registrar).
CAtlModule::AddTermFunc Menambahkan fungsi baru yang akan dipanggil saat modul berakhir.
CAtlModule::GetGITPtr Mengembalikan Penunjuk Antarmuka Global.
CAtlModule::GetLockCount Mengembalikan jumlah kunci.
CAtlModule::Lock Menaikkan jumlah kunci.
CAtlModule::Istilah Merilis semua anggota data.
CAtlModule::Buka kunci Mengurangi jumlah kunci.
CAtlModule::UpdateRegistryFromResourceD Menjalankan skrip yang terkandung dalam sumber daya tertentu untuk mendaftarkan atau membatalkan pendaftaran objek.
CAtlModule::UpdateRegistryFromResourceDHelper Metode ini dipanggil oleh UpdateRegistryFromResourceD untuk melakukan pembaruan registri.
CAtlModule::UpdateRegistryFromResourceS Menjalankan skrip yang terkandung dalam sumber daya tertentu untuk mendaftarkan atau membatalkan pendaftaran objek. Metode ini secara statis menautkan ke Komponen Registri ATL.

Anggota Data Publik

Nama Deskripsi
CAtlModule::m_libid Berisi GUID modul saat ini.
CAtlModule::m_pGIT Penunjuk ke Tabel Antarmuka Global.

Keterangan

Kelas ini digunakan oleh Kelas CAtlDllModuleT, Kelas CAtlExeModuleT, dan Kelas CAtlServiceModuleT untuk memberikan dukungan untuk aplikasi DLL, aplikasi EXE, dan layanan Windows.

Untuk informasi selengkapnya tentang modul di ATL, lihat Kelas Modul ATL.

Kelas ini menggantikan Kelas CComModule usang yang digunakan dalam versi ATL yang lebih lama.

Hierarki Warisan

_ATL_MODULE

CAtlModule

Persyaratan

Header: atlbase.h

CAtlModule::AddCommonRGSReplacements

Ambil alih metode ini untuk menambahkan parameter ke peta penggantian Komponen Registri ATL (Registrar).

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

Parameter

pRegistrar
Dicadangkan.

Tampilkan Nilai

Mengembalikan S_OK saat berhasil, atau kesalahan HRESULT saat gagal.

Keterangan

Parameter yang dapat diganti memungkinkan klien Registrar menentukan data run-time. Untuk melakukan ini, Registrar mempertahankan peta pengganti di mana ia memasukkan nilai yang terkait dengan parameter yang dapat diganti dalam skrip Anda. Pencatat membuat entri ini pada waktu proses.

Lihat topik Menggunakan Parameter yang Dapat Diganti (Preprocessor Registrar) untuk detail selengkapnya.

CAtlModule::AddTermFunc

Menambahkan fungsi baru yang akan dipanggil saat modul berakhir.

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

Parameter

pFunc
Penunjuk ke fungsi untuk ditambahkan.

Dw
Data yang ditentukan pengguna, diteruskan ke fungsi .

Tampilkan Nilai

Mengembalikan S_OK saat berhasil, atau kesalahan HRESULT saat gagal.

CAtlModule::CAtlModule

Konstruktor.

CAtlModule() throw();

Keterangan

Menginisialisasi anggota data dan memulai bagian penting di sekitar utas modul.

CAtlModule::~CAtlModule

Destruktor.

~CAtlModule() throw();

Keterangan

Merilis semua anggota data.

CAtlModule::GetGITPtr

Mengambil penunjuk ke Tabel Antarmuka Global.

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

Parameter

ppGIT
Penunjuk ke variabel yang akan menerima penunjuk ke Tabel Antarmuka Global.

Tampilkan Nilai

Mengembalikan S_OK pada keberhasilan, atau kode kesalahan pada kegagalan. E_POINTER dikembalikan jika ppGIT sama dengan NULL.

Keterangan

Jika objek Tabel Antarmuka Global tidak ada, objek tersebut dibuat, dan alamatnya disimpan dalam variabel anggota CAtlModule::m_pGIT.

Dalam build debug, kesalahan pernyataan akan terjadi jika ppGIT sama dengan NULL, atau jika penunjuk Tabel Antarmuka Global tidak dapat diperoleh.

Lihat IGlobalInterfaceTable untuk informasi tentang Tabel Antarmuka Global.

CAtlModule::GetLockCount

Mengembalikan jumlah kunci.

virtual LONG GetLockCount() throw();

Tampilkan Nilai

Mengembalikan jumlah kunci. Nilai ini mungkin berguna untuk diagnostik dan penelusuran kesalahan.

CAtlModule::Lock

Menaikkan jumlah kunci.

virtual LONG Lock() throw();

Tampilkan Nilai

Menaikkan jumlah kunci dan mengembalikan nilai yang diperbarui. Nilai ini mungkin berguna untuk diagnostik dan penelusuran kesalahan.

CAtlModule::m_libid

Berisi GUID modul saat ini.

static GUID m_libid;

CAtlModule::m_pGIT

Penunjuk ke Tabel Antarmuka Global.

IGlobalInterfaceTable* m_pGIT;

CAtlModule::Istilah

Merilis semua anggota data.

void Term() throw();

Keterangan

Merilis semua anggota data. Metode ini disebut oleh destruktor.

CAtlModule::Buka kunci

Mengurangi jumlah kunci.

virtual LONG Unlock() throw();

Tampilkan Nilai

Mengurangi jumlah kunci dan mengembalikan nilai yang diperbarui. Nilai ini mungkin berguna untuk diagnostik dan penelusuran kesalahan.

CAtlModule::UpdateRegistryFromResourceD

Menjalankan skrip yang terkandung dalam sumber daya tertentu untuk mendaftarkan atau membatalkan pendaftaran objek.

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

Parameter

lpszRes
Nama sumber daya.

nResID
ID sumber daya.

bRegister
TRUE jika objek harus didaftarkan; FALSE jika tidak.

pMapEntries
Penunjuk ke nilai penyimpanan peta pengganti yang terkait dengan parameter skrip yang dapat diganti. ATL secara otomatis menggunakan %MODULE%. Untuk menggunakan parameter tambahan yang dapat diganti, lihat CAtlModule::AddCommonRGSReplacements. Jika tidak, gunakan nilai default NULL.

Tampilkan Nilai

Mengembalikan S_OK saat berhasil, atau kesalahan HRESULT saat gagal.

Keterangan

Menjalankan skrip yang terkandung dalam sumber daya yang ditentukan oleh lpszRes atau nResID. Jika bRegister TRUE, metode ini mendaftarkan objek dalam registri sistem; jika tidak, itu akan menghapus objek dari registri.

Untuk menautkan secara statis ke Komponen Registri ATL (Registrar), lihat CAtlModule::UpdateRegistryFromResourceS.

Metode ini memanggil CAtlModule::UpdateRegistryFromResourceDHelper dan IRegistrar::ResourceUnregister.

CAtlModule::UpdateRegistryFromResourceDHelper

Metode ini dipanggil oleh UpdateRegistryFromResourceD untuk melakukan pembaruan registri.

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

Parameter

lpszRes
Nama sumber daya.

bRegister
Menunjukkan apakah objek harus didaftarkan.

pMapEntries
Penunjuk ke nilai penyimpanan peta pengganti yang terkait dengan parameter skrip yang dapat diganti. ATL secara otomatis menggunakan %MODULE%. Untuk menggunakan parameter tambahan yang dapat diganti, lihat CAtlModule::AddCommonRGSReplacements. Jika tidak, gunakan nilai default NULL.

Tampilkan Nilai

Mengembalikan S_OK saat berhasil, atau kesalahan HRESULT saat gagal.

Keterangan

Metode ini menyediakan implementasi CAtlModule::UpdateRegistryFromResourceD.

CAtlModule::UpdateRegistryFromResourceS

Menjalankan skrip yang terkandung dalam sumber daya tertentu untuk mendaftarkan atau membatalkan pendaftaran objek. Metode ini secara statis menautkan ke Komponen Registri 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();

Parameter

nResID
ID sumber daya.

lpszRes
Nama sumber daya.

bRegister
Menunjukkan apakah skrip sumber daya harus didaftarkan.

pMapEntries
Penunjuk ke nilai penyimpanan peta pengganti yang terkait dengan parameter skrip yang dapat diganti. ATL secara otomatis menggunakan %MODULE%. Untuk menggunakan parameter tambahan yang dapat diganti, lihat CAtlModule::AddCommonRGSReplacements. Jika tidak, gunakan nilai default NULL.

Tampilkan Nilai

Mengembalikan S_OK saat berhasil, atau kesalahan HRESULT saat gagal.

Keterangan

Mirip dengan CAtlModule::UpdateRegistryFromResourceD kecuali CAtlModule::UpdateRegistryFromResourceS membuat tautan statis ke Komponen Registri ATL (Registrar).

Lihat juga

_ATL_MODULE
Gambaran Umum Kelas
Kelas Modul
Komponen Registri (Registrar)