CComModule クラス

[アーティクル]
04/03/2023

ATL 7.0 以降、CComModule は非推奨になりました。詳細については、「ATL モジュールクラス」を参照してください。

重要

このクラスとそのメンバーは、Windows ランタイムで実行するアプリケーションで使用することはできません。

構文

class CComModule : public _ATL_MODULE

メンバー

パブリックメソッド

名前	説明
CComModule::GetClassObject	指定した CLSID のオブジェクトを作成します。 DLL 専用。
CComModule::GetModuleInstance	`m_hInst` を返します。
CComModule::GetResourceInstance	`m_hInstResource` を返します。
CComModule::GetTypeLibInstance	`m_hInstTypeLib` を返します。
CComModule::Init	データメンバーを初期化します。
CComModule::RegisterClassHelper	オブジェクトの標準クラスの登録をシステムレジストリに入力します。
CComModule::RegisterClassObjects	クラスオブジェクトを登録します。 EXE 専用。
CComModule::RegisterServer	オブジェクトマップ内の各オブジェクトのシステムレジストリを更新します。
CComModule::RegisterTypeLib	タイプライブラリを登録します。
CComModule::RevokeClassObjects	クラスオブジェクトを取り消します。 EXE 専用。
CComModule::Term	データメンバーを解放します。
CComModule::UnregisterClassHelper	オブジェクトの標準クラスの登録をシステムレジストリから削除します。
CComModule::UnregisterServer	オブジェクトマップ内の各オブジェクトの登録を解除します。
CComModule::UpdateRegistryClass	オブジェクトの標準クラスの登録を登録するか登録解除します。
CComModule::UpdateRegistryFromResourceD	指定したリソースに含まれているスクリプトを実行して、オブジェクトの登録または登録解除を行います。
CComModule::UpdateRegistryFromResourceS	ATL レジストリコンポーネントに静的にリンクします。指定したリソースに含まれているスクリプトを実行して、オブジェクトの登録または登録解除を行います。

パブリックデータメンバー

名前	説明
CComModule::m_csObjMap	オブジェクトマップ情報への同期アクセスを保証します。
CComModule::m_csTypeInfoHolder	タイプライブラリ情報への同期アクセスを保証します。
CComModule::m_csWindowCreate	ウィンドウの作成時に使用されるウィンドウクラス情報と静的データへの同期アクセスを保証します。
CComModule::m_hInst	モジュールインスタンスへのハンドルを格納します。
CComModule::m_hInstResource	既定で、モジュールインスタンスへのハンドルを格納します。
CComModule::m_hInstTypeLib	既定で、モジュールインスタンスへのハンドルを格納します。
CComModule::m_pObjMap	モジュールインスタンスによって管理されるオブジェクトマップを指定します。

解説

Note

このクラスは非推奨です。現在、ATL コード生成ウィザードによって CAtlAutoThreadModule 派生クラスおよび CAtlModule 派生クラスが使用されます。詳細については、「ATL モジュールクラス」を参照してください。この後の情報は、ATL の旧リリースで作成されたアプリケーションで使用するためのものです。 CComModule は、以前の機能に備えて引き続き ATL に含まれています。

CComModule は、COM サーバーモジュールを実装し、クライアントがモジュールのコンポーネントにアクセスできるようにします。 CComModule は、DLL (インプロセス) と EXE (ローカル) 両方のモジュールをサポートします。

CComModule インスタンスは、オブジェクトマップを使用して、クラスオブジェクト定義のセットを管理します。このオブジェクトマップは、_ATL_OBJMAP_ENTRY 構造体の配列として実装され、次のための情報を含みます。

システムレジストリでのオブジェクトの説明の入力および削除。
クラスファクトリを使用したオブジェクトのインスタンス化。
クライアントとコンポーネント内のルートオブジェクトとの通信の確立。
クラスオブジェクトの有効期間管理の実行。

ATL COM AppWizard を実行すると、ウィザードによって、CComModule またはそれから派生したクラスのグローバルインスタンスである _Module が自動的に生成されます。 ATL プロジェクトウィザードの詳細については、「ATL プロジェクトの作成」を参照してください。

CComModule に加え、ATL には CComAutoThreadModule が用意されており、これによって、EXE および Windows サービスのアパートメントモデルモジュールが実装されます。複数のアパートメントにオブジェクトを作成する場合は、CComAutoThreadModule からモジュールを派生させます。

継承階層

_ATL_MODULE

CAtlModule

CAtlModuleT

CComModule

必要条件

ヘッダー: atlbase.h

CComModule::GetClassObject

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT GetClassObject(
    REFCLSID rclsid,
    REFIID riid,
    LPVOID* ppv) throw();

パラメーター

rclsid
[入力] 作成するオブジェクトの CLSID。

riid
[入力] 要求されたインターフェイスの IID。

ppv
[出力] riid によって識別されるインターフェイスポインターへのポインター。オブジェクトでこのインターフェイスがサポートされていない場合、ppv は NULL に設定されます。

戻り値

標準の HRESULT 値。

解説

指定した CLSID のオブジェクトを作成し、このオブジェクトへのインターフェイスポインターを取得します。

GetClassObject は、DLL でのみ使用できます。

CComModule::GetModuleInstance

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE GetModuleInstance() throw();

戻り値

このモジュールを識別する HINSTANCE。

解説

m_hInst データメンバーを返します。

CComModule::GetResourceInstance

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE GetResourceInstance() throw();

戻り値

HINSTANCE。

解説

m_hInstResource データメンバーを返します。

CComModule::GetTypeLibInstance

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE GetTypeLibInstance() const throw();

戻り値

HINSTANCE。

解説

m_hInstTypeLib データメンバーを返します。

CComModule::Init

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT Init(
    _ATL_OBJMAP_ENTRY* p,
    HINSTANCE h,
    const GUID* plibid = NULL) throw();

パラメーター

P
[入力] オブジェクトマップエントリの配列へのポインター。

時
[入力] DLLMain または WinMain に渡される HINSTANCE。

plibid
[入力] プロジェクトに関連付けられたタイプライブラリの LIBID へのポインター。

戻り値

標準の HRESULT 値。

解説

すべてのデータメンバーを初期化します。

CComModule::m_csObjMap

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

CRITICAL_SECTION m_csObjMap;

解説

オブジェクトマップへの同期アクセスを保証します。

CComModule::m_csTypeInfoHolder

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

CRITICAL_SECTION m_csTypeInfoHolder;

解説

タイプライブラリへの同期アクセスを保証します。

CComModule::m_csWindowCreate

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

CRITICAL_SECTION m_csWindowCreate;

解説

ウィンドウの作成時に使用されるウィンドウクラス情報と静的データへの同期アクセスを保証します。

CComModule::m_hInst

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE m_hInst;

解説

モジュールインスタンスへのハンドルを格納します。

Init メソッドによって、DLLMain または WinMain に渡されるハンドルが m_hInst に設定されます。

CComModule::m_hInstResource

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE m_hInstResource;

解説

既定で、モジュールインスタンスへのハンドルを格納します。

Init メソッドによって、DLLMain または WinMain に渡されるハンドルが m_hInstResource に設定されます。リソースに対するハンドルを m_hInstResource に明示的に設定できます。

GetResourceInstance メソッドは、m_hInstResource に格納されているハンドルを返します。

CComModule::m_hInstTypeLib

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HINSTANCE m_hInstTypeLib;

解説

既定で、モジュールインスタンスへのハンドルを格納します。

Init メソッドによって、DLLMain または WinMain に渡されるハンドルが m_hInstTypeLib に設定されます。タイプライブラリに対するハンドルを m_hInstTypeLib に明示的に設定できます。

GetTypeLibInstance メソッドは、m_hInstTypeLib に格納されているハンドルを返します。

CComModule::m_pObjMap

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

_ATL_OBJMAP_ENTRY* m_pObjMap;

解説

モジュールインスタンスによって管理されるオブジェクトマップを指定します。

CComModule::RegisterClassHelper

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

ATL_DEPRECATED HRESULT RegisterClassHelper(
    const CLSID& clsid,
    LPCTSTR lpszProgID,
    LPCTSTR lpszVerIndProgID,
    UINT nDescID,
    DWORD dwFlags);

パラメーター

clsid
[入力] 登録するオブジェクトの CLSID。

lpszProgID
[入力] オブジェクトに関連付けられている ProgID。

lpszVerIndProgID
[入力] オブジェクトに関連付けられている、バージョンに依存しない ProgID。

nDescID
[入力] オブジェクトの説明の文字列リソースの識別子。

dwFlags
[入力] レジストリに入力するスレッドモデルを指定します。指定できる値は、THREADFLAGS_APARTMENT、THREADFLAGS_BOTH、または AUTPRXFLAG です。

戻り値

標準の HRESULT 値。

解説

オブジェクトの標準クラスの登録をシステムレジストリに入力します。

UpdateRegistryClass メソッドは RegisterClassHelper を呼び出します。

CComModule::RegisterClassObjects

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT RegisterClassObjects(DWORD dwClsContext, DWORD dwFlags) throw();

パラメーター

dwClsContext
[入力] クラスオブジェクトを実行するコンテキストを指定します。指定できる値は、CLSCTX_INPROC_SERVER、CLSCTX_INPROC_HANDLER、または CLSCTX_LOCAL_SERVER です。これらの値の詳細については、Windows SDK の「CLSCTX」を参照してください。

dwFlags
[入力] クラスオブジェクトへの接続の種類を決定します。指定できる値は、REGCLS_SINGLEUSE、REGCLS_MULTIPLEUSE、または REGCLS_MULTI_SEPARATE です。これらの値の詳細については、Windows SDK の「REGCLS」を参照してください。

戻り値

標準の HRESULT 値。

解説

他のアプリケーションが OLE に接続できるよう、EXE クラスオブジェクトを OLE に登録します。このメソッドは、EXE でのみ使用できます。

CComModule::RegisterServer

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT RegisterServer(
    BOOL bRegTypeLib = FALSE,
    const CLSID* pCLSID = NULL) throw();

パラメーター

bRegTypeLib
[入力] タイプライブラリを登録するかどうかを示します。既定値は FALSE です。

pCLSID
[入力] 登録するオブジェクトの CLSID を指定します。 NULL (既定値) の場合、オブジェクトマップ内のすべてのオブジェクトが登録されます。

戻り値

標準の HRESULT 値。

解説

pCLSID パラメーターに基づき、1 つのクラスオブジェクトまたはオブジェクトマップ内のすべてのオブジェクトに対して、システムレジストリを更新します。

bRegTypeLib が TRUE の場合、タイプライブラリ情報も更新されます。

エントリをオブジェクトマップに追加する方法の詳細については、「OBJECT_ENTRY_AUTO」を参照してください。

RegisterServer は、/RegServer コマンドラインオプションが指定されると、DLL 実行では DLLRegisterServer によって、EXE 実行では WinMain によって自動的に呼び出されます。

CComModule::RegisterTypeLib

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT RegisterTypeLib() throw();
HRESULT RegisterTypeLib(LPCTSTR lpszIndex) throw();

パラメーター

lpszIndex
[入力] "\\N" という形式の文字列。N は TYPELIB リソースの整数のインデックスです。

戻り値

標準の HRESULT 値。

解説

タイプライブラリに関する情報をシステムレジストリに追加します。

モジュールインスタンスに複数のタイプライブラリが含まれている場合は、このメソッドの 2 番目のバージョンを使用して、使用するタイプライブラリを指定します。

CComModule::RevokeClassObjects

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT RevokeClassObjects() throw();

戻り値

標準の HRESULT 値。

解説

クラスオブジェクトを削除します。このメソッドは、EXE でのみ使用できます。

CComModule::Term

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

void Term() throw();

解説

すべてのデータメンバーを解放します。

CComModule::UnregisterClassHelper

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

ATL_DEPRECATED HRESULT UnregisterClassHelper(
    const CLSID& clsid,
    LPCTSTR lpszProgID,
    LPCTSTR lpszVerIndProgID);

パラメーター

clsid
[入力] 登録解除するオブジェクトの CLSID。

lpszProgID
[入力] オブジェクトに関連付けられている ProgID。

lpszVerIndProgID
[入力] オブジェクトに関連付けられている、バージョンに依存しない ProgID。

戻り値

標準の HRESULT 値。

解説

オブジェクトの標準クラスの登録をシステムレジストリから削除します。

UpdateRegistryClass メソッドは UnregisterClassHelper を呼び出します。

CComModule::UnregisterServer

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

HRESULT UnregisterServer(const CLSID* pCLSID = NULL) throw ();
inline HRESULT UnregisterServer(BOOL bUnRegTypeLib, const CLSID* pCLSID = NULL) throw ();

パラメーター

bUnRegTypeLib
TRUE の場合、タイプライブラリも登録解除されます。

pCLSID
登録解除するオブジェクトの CLSID を指します。 NULL (既定値) の場合、オブジェクトマップ内のすべてのオブジェクトが登録解除されます。

戻り値

標準の HRESULT 値。

解説

pCLSID パラメーターに基づき、1 つのクラスオブジェクトまたはオブジェクトマップ内のすべてのオブジェクトを登録解除します。

UnregisterServer は、/UnregServer コマンドラインオプションが指定されると、DLL 実行では DLLUnregisterServer によって、EXE 実行では WinMain によって自動的に呼び出されます。

エントリをオブジェクトマップに追加する方法の詳細については、「OBJECT_ENTRY_AUTO」を参照してください。

CComModule::UpdateRegistryClass

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

ATL_DEPRECATED HRESULT UpdateRegistryClass(
    const CLSID& clsid,
    LPCTSTR lpszProgID,
    LPCTSTR lpszVerIndProgID,
    UINT nDescID,
    DWORD dwFlags,
    BOOL bRegister);

ATL_DEPRECATED HRESULT UpdateRegistryClass(
    const CLSID& clsid,
    LPCTSTR lpszProgID,
    LPCTSTR lpszVerIndProgID,
    LPCTSTR szDesc,
    DWORD dwFlags,
    BOOL bRegister);

パラメーター

clsid
登録または登録解除するオブジェクトの CLSID。

lpszProgID
オブジェクトに関連付けられている ProgID。

lpszVerIndProgID
オブジェクトに関連付けられている、バージョンに依存しない ProgID。

nDescID
オブジェクトの説明の文字列リソースの識別子。

szDesc
オブジェクトの説明を含む文字列。

dwFlags
レジストリに入力するスレッドモデルを指定します。指定できる値は、THREADFLAGS_APARTMENT、THREADFLAGS_BOTH、または AUTPRXFLAG です。

bRegister
オブジェクトを登録するかどうかを示します。

戻り値

標準の HRESULT 値。

解説

bRegister が TRUE の場合、このメソッドはオブジェクトの標準クラス登録をシステムレジストリに入力します。

bRegister が FALSE の場合、オブジェクトの登録を削除します。

bRegister の値に応じて、UpdateRegistryClass は RegisterClassHelper または UnregisterClassHelper を呼び出します。

DECLARE_REGISTRY マクロを指定すると、オブジェクトマップが処理されるときに UpdateRegistryClass が自動的に呼び出されます。

CComModule::UpdateRegistryFromResourceD

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

virtual HRESULT UpdateRegistryFromResourceD(
    LPCTSTR lpszRes,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

virtual HRESULT UpdateRegistryFromResourceD(
    UINT nResID,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw ();

パラメーター

lpszRes
[入力] リソースの名前。

nResID
[入力] リソース ID。

bRegister
[入力] オブジェクトを登録するかどうかを示します。

pMapEntries
[入力] スクリプトの置換可能なパラメーターに関連付けられている値を格納する置換マップへのポインター。 ATL は自動的に %MODULE% を使用します。追加の置換可能なパラメーターを使用するには、詳細について「解説」を参照してください。それ以外の場合は、既定値 NULL を使用します。

戻り値

標準の HRESULT 値。

解説

lpszRes または nResID によって指定されるリソースに含まれるスクリプトを実行します。

bRegister が TRUE の場合、このメソッドはオブジェクトをシステムレジストリに登録します。それ以外の場合は、オブジェクトの登録を解除します。

DECLARE_REGISTRY_RESOURCE または DECLARE_REGISTRY_RESOURCEID マクロを指定すると、オブジェクトマップが処理されるときに UpdateRegistryFromResourceD が自動的に呼び出されます。

Note

実行時に置換値を代入する場合は、DECLARE_REGISTRY_RESOURCE または DECLARE_REGISTRY_RESOURCEID マクロを指定しないでください。代わりに、_ATL_REGMAP_ENTRIES 構造体の配列を作成します。この各エントリには、変数のプレースホルダーと、そのプレースホルダーを実行時に置換する値のペアが含まれています。その後、UpdateRegistryFromResourceD を呼び出して、この配列を pMapEntries パラメーターに渡します。これにより、_ATL_REGMAP_ENTRIES 構造体内のすべての置換値がレジストラーの置換マップに追加されます。

Note

ATL レジストリコンポーネント (レジストラー) に静的にリンクするには、「UpdateRegistryFromResourceS」を参照してください。

置換可能パラメーターとスクリプト化の詳細については、ATL レジストリコンポーネント (レジストラー) の記事を参照してください。

CComModule::UpdateRegistryFromResourceS

ATL 7.0 以降、CComModule は古くなりました。詳細については、「ATL モジュールクラス」を参照してください。

virtual HRESULT UpdateRegistryFromResourceS(
    LPCTSTR lpszRes,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

virtual HRESULT UpdateRegistryFromResourceS(
    UINT nResID,
    BOOL bRegister,
    struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

パラメーター

lpszRes
[入力] リソースの名前。

nResID
[入力] リソース ID。

bRegister
[入力] リソーススクリプトを登録するかどうかを示します。

戻り値

標準の HRESULT 値。

解説

UpdateRegistryFromResourceD に似ていますが、UpdateRegistryFromResourceS は ATL レジストリコンポーネント (レジストラー) への静的リンクを作成する点が異なります。

UpdateRegistryFromResourceS は、#define _ATL_STATIC_REGISTRY を pch.h (Visual Studio 2017 以前では stdafx.h) に追加した場合、オブジェクトマップが処理されると自動的に呼び出されます。

Note

実行時に置換値を代入する場合は、DECLARE_REGISTRY_RESOURCE または DECLARE_REGISTRY_RESOURCEID マクロを指定しないでください。代わりに、_ATL_REGMAP_ENTRIES 構造体の配列を作成します。この各エントリには、変数のプレースホルダーと、そのプレースホルダーを実行時に置換する値のペアが含まれています。その後、UpdateRegistryFromResourceS を呼び出して、この配列を pMapEntries パラメーターに渡します。これにより、_ATL_REGMAP_ENTRIES 構造体内のすべての置換値がレジストラーの置換マップに追加されます。

置換可能パラメーターとスクリプト化の詳細については、ATL レジストリコンポーネント (レジストラー) の記事を参照してください。

CComModule クラス

構文

メンバー

パブリック メソッド

パブリック データ メンバー

解説

継承階層

必要条件

CComModule::GetClassObject

パラメーター

戻り値

解説

CComModule::GetModuleInstance

戻り値

解説

CComModule::GetResourceInstance

戻り値

解説

CComModule::GetTypeLibInstance

戻り値

解説

CComModule::Init

パラメーター

戻り値

解説

CComModule::m_csObjMap

解説

CComModule::m_csTypeInfoHolder

解説

CComModule::m_csWindowCreate

解説

CComModule::m_hInst

解説

CComModule::m_hInstResource

解説

CComModule::m_hInstTypeLib

解説

CComModule::m_pObjMap

解説

CComModule::RegisterClassHelper

パラメーター

戻り値

解説

CComModule::RegisterClassObjects

パラメーター

戻り値

解説

CComModule::RegisterServer

パラメーター

戻り値

解説

CComModule::RegisterTypeLib

パラメーター

戻り値

解説

CComModule::RevokeClassObjects

戻り値

解説

CComModule::Term

解説

CComModule::UnregisterClassHelper

パラメーター

戻り値

解説

CComModule::UnregisterServer

パラメーター

戻り値

解説

CComModule::UpdateRegistryClass

パラメーター

戻り値

解説

CComModule::UpdateRegistryFromResourceD

パラメーター

戻り値

解説

CComModule::UpdateRegistryFromResourceS

パラメーター

戻り値

解説

パブリックメソッド

パブリックデータメンバー