CAtlComModule クラス

  • [アーティクル]

このクラスは、COM サーバー モジュールを実装します。

構文

class CAtlComModule : public _ATL_COM_MODULE

メンバー

パブリック コンストラクター

名前 説明
CAtlComModule::CAtlComModule コンストラクター。
CAtlComModule::~CAtlComModule デストラクター。

パブリック メソッド

名前 説明
CAtlComModule::RegisterServer オブジェクト マップ内の各オブジェクトのシステム レジストリを更新するには、このメソッドを呼び出します。
CAtlComModule::RegisterTypeLib タイプ ライブラリを登録するには、このメソッドを呼び出します。
CAtlComModule::UnregisterServer オブジェクト マップ内の各オブジェクトの登録を解除するには、このメソッドを呼び出します。
CAtlComModule::UnRegisterTypeLib タイプ ライブラリの登録を解除するには、このメソッドを呼び出します。

解説

CAtlComModule は、COM サーバー モジュールを実装し、クライアントがモジュールのコンポーネントにアクセスできるようにします。

このクラスは、ATL の以前のバージョンで使用されていた古い CComModule クラスに代わるものです。 詳細については、「ATL モジュール クラス」を参照してください。

継承階層

_ATL_COM_MODULE

CAtlComModule

必要条件

ヘッダー: atlbase.h

CAtlComModule::CAtlComModule

コンストラクター。

CAtlComModule() throw();

解説

モジュールを初期化します。

CAtlComModule::~CAtlComModule

デストラクター。

~CAtlComModule();

解説

すべてのクラス ファクトリを解放します。

CAtlComModule::RegisterServer

オブジェクト マップ内の各オブジェクトのシステム レジストリを更新するには、このメソッドを呼び出します。

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

パラメーター

bRegTypeLib
タイプ ライブラリを登録する場合は TRUE。 既定値は FALSE です。

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

戻り値

成功した場合は S_OK、失敗した場合はエラー HRESULT を返します。

解説

グローバル関数 AtlComModuleRegisterServer を呼び出します。

CAtlComModule::RegisterTypeLib

タイプ ライブラリを登録するには、このメソッドを呼び出します。

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

パラメーター

lpszIndex
"\\N" の形式の文字列。ここで、N は、TYPELIB リソースの整数のインデックスです。

戻り値

成功した場合は S_OK、失敗した場合はエラー HRESULT を返します。

解説

タイプ ライブラリに関する情報をシステム レジストリに追加します。 モジュール インスタンスに複数のタイプ ライブラリが含まれている場合は、このメソッドの最初のバージョンを使用して、使用するタイプ ライブラリを指定します。

CAtlComModule::UnregisterServer

オブジェクト マップ内の各オブジェクトの登録を解除するには、このメソッドを呼び出します。

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

パラメーター

bRegTypeLib
タイプ ライブラリの登録を解除する場合は TRUE。 既定値は FALSE です。

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

戻り値

成功した場合は S_OK、失敗した場合はエラー HRESULT を返します。

解説

グローバル関数 AtlComModuleUnregisterServer を呼び出します。

CAtlComModule::UnRegisterTypeLib

タイプ ライブラリの登録を解除するには、このメソッドを呼び出します。

HRESULT UnRegisterTypeLib(LPCTSTR lpszIndex);
HRESULT UnRegisterTypeLib();

パラメーター

lpszIndex
"\\N" の形式の文字列。ここで、N は、TYPELIB リソースの整数のインデックスです。

解説

タイプ ライブラリに関する情報をシステム レジストリから削除します。 モジュール インスタンスに複数のタイプ ライブラリが含まれている場合は、このメソッドの最初のバージョンを使用して、使用するタイプ ライブラリを指定します。

戻り値

成功した場合は S_OK、失敗した場合はエラー HRESULT を返します。

関連項目

_ATL_COM_MODULE
クラスの概要