ICertManageModule

Certificate Services のポリシーモジュールまたは Exit モジュールに関する情報を取得するために提供されます。

ICertManageModule インターフェイスは、構成設定の設定および表示を行うためのモジュールのユーザーインターフェイスを呼び出すメソッドを提供します。ポリシーモジュールおよび Exit モジュールの作成者は、(それぞれ ICertPolicy インターフェイスおよび ICertExit インターフェイスに加えて)ICertManageModule インターフェイスを実装する必要があります。エンタープライズの証明機関(CA)では、常に Microsoft が提供するエンタープライズ用のポリシーモジュールと Exit モジュールを使用する必要があります。エンタープライズ CA では追加の Exit モジュールを使用できます。

次に示すのは、ICertManageModule を実装するクラス(CMyCertManagePolicyModule)の DECLARE_REGISTRY マクロで使用できる例です。

DECLARE_REGISTRY(
    CMyCertManagePolicyModule,
    L"MyCode.PolicyManage.1",
    L"MyCode.PolicyManage",
    IDS_CERTMANAGEPOLICYMODULE_DESC,
    THREADFLAGS_BOTH);

IDS_CERTMANAGEPOLICYMODULE_DESC の値は、クラスを説明するリソースファイル(.rc)内の文字列テーブルの文字列を識別する、アプリケーション固有の識別子です。

ICertManageModule は Certmod.h で定義されています。ただし、プログラムを作成する際は、インクルードファイルとして Certsrv.h を使用してください。

Certificate Services のインターフェイスは、アパートメントスレッドモデルとフリースレッドモデルの両方をサポートします。スループットを向上させるには、フリースレッドを推奨します。

Visual Basic Scripting Edition では、ICertManageModule を実装するクラスの名前は、作成するモジュールの種類に応じて "PolicyManage" または "PolicyExit" のいずれかである必要があります。命名規則に従いやすくするために、Certmod.h で定義された次の文字列定数を使用できます。

モジュールのプロパティ値を取得します。

C++

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

VB

ICertManageModule を実装すると、Certificate Services マネージャーは GetProperty を呼び出してモジュールのプロパティを取得できます。取得したプロパティは、ポリシーモジュールおよび Exit モジュール用の Certificate Services マネージャーのプロパティページに表示できます。Certificate Services マネージャーは strStorageLocation で参照される場所をこのモジュールに渡し、将来のバージョンでは、このメソッドの実装が必要に応じてこの場所を使用できます。次の例では strStorageLocation を使用せず、代わりにプロパティ値をメモリ内で保持します。

例

#include <windows.h>
#include <Certmod.h>

HRESULT CCertManagePolicyModule::GetProperty(
            /* [in] */ const BSTR strConfig,
            /* [in] */ BSTR strStorageLocation,
            /* [in] */ BSTR strPropertyName,
            /* [in] */ LONG Flags,
            /* [retval][out] */ VARIANT *pvarProperty)
{
    // Array of property Names.
    // These values are defined in Certmod.h.
    wchar_t const * awszPropName[] =
    {
        wszCMM_PROP_NAME,
        wszCMM_PROP_DESCRIPTION,
        wszCMM_PROP_COPYRIGHT,
        wszCMM_PROP_FILEVER,
        wszCMM_PROP_PRODUCTVER
    };

    // Array of property Values.
    // These values are module-specific, and
    // correspond to the property names in    
    // awszPropName (same index).
    wchar_t const * awszPropValue[] = 
   {
        L"MyModule",                      // NAME
        L"Description of MyModule",       // DESCRIPTION
        L"Copyright 1998",                // COPYRIGHT
        L"1.0",                           // FILE VERSION
        L"1.0"                            // PRODUCT VERSION
    };
    int     i;
    bool    bFound = FALSE;
    HRESULT hr;

    // Return appropriate error if strPropertyName is NULL.
    if (NULL == strPropertyName)
        return E_INVALIDARG;

    // Return appropriate error if pvarProperty is NULL.
    if (NULL == pvarProperty)
        return E_POINTER;
    // Determine whether the requested property is in the Name array.
    for (i=0; i<sizeof(awszPropName)/sizeof(wchar_t *); i++)
        if (!wcscmp( strPropertyName, awszPropName[i]))        
        {
            bFound = TRUE;  // Found the index for the property.
            break;
        }
    if ( !bFound )
        return S_FALSE;     // Requested property not found.

    // Allocate storage for the property value.
    pvarProperty->bstrVal = SysAllocString(awszPropValue[i]);
    if (NULL == pvarProperty->bstrVal)
        return E_OUTOFMEMORY;   

    pvarProperty->vt = VT_BSTR;

    return S_OK;
}

モジュールがプロパティ値を設定できるようにします。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

このメソッドは将来の機能のために用意されています。ただし、ICertManageModule インターフェイスの要件を満たすために、最小限の実装が必要です。

例

#include <windows.h>
#include <Certmod.h>

HRESULT CCertManagePolicyModule::SetProperty(
            /* [in] */ const BSTR strConfig,
            /* [in] */ BSTR strStorageLocation,
            /* [in] */ BSTR strPropertyName,
            /* [in] */ LONG Flags,
            /* [in] */ const VARIANT *pvarProperty)
{
    // This implementation fulfills the minimal requirement
    // needed for ICertManageModule::SetProperty.
    return S_OK;
}

モジュールのユーザーインターフェイスを表示します。

VB

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

Configure メソッドは、モジュールのユーザーインターフェイス(存在する場合)を表示し、ユーザーがモジュールの構成可能な項目を表示および変更できるようにします。 ICertManageModule を実装するモジュールは、Certificate Services マネージャーのポリシーモジュールまたは Exit モジュールのプロパティページがアクティブで、ユーザーが Configure ボタンを選択したときに、その Configure メソッドを呼び出すことができます。Certificate Services マネージャーは strStorageLocation で参照される場所をこのモジュールに渡し、このメソッドの実装は必要に応じてこの場所を使用できます。モジュールに構成可能な項目がない場合(したがって、ユーザーインターフェイスが不要な場合)もありますが、その場合でもこのメソッドを実装する必要があることに注意してください。以下の例では、ユーザーが構成を変更することはできませんが、このメソッドを実装しています。

例

#include <windows.h>
#include <Certmod.h>

HRESULT CCertManagePolicyModule::Configure( 
            /* [in] */ const BSTR strConfig,
            /* [in] */ BSTR strStorageLocation,
            /* [in] */ LONG Flags)
{
    if ( CMM_REFRESHONLY != Flags )
        MessageBox(NULL,
                   L"This module has no configurable items",
                   L"MyModule",
                   (MB_OK|MB_ICONINFORMATION));

    return S_OK;
}