ObjectExtenders.RegisterExtenderProvider メソッド

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

指定したエクステンダカテゴリに拡張プロバイダを登録します。

名前空間 : EnvDTE
アセンブリ : EnvDTE (EnvDTE.dll 内)

構文

'宣言
Function RegisterExtenderProvider ( _
    ExtenderCATID As String, _
    ExtenderName As String, _
    ExtenderProvider As IExtenderProvider, _
    LocalizedName As String _
) As Integer
'使用
Dim instance As ObjectExtenders
Dim ExtenderCATID As String
Dim ExtenderName As String
Dim ExtenderProvider As IExtenderProvider
Dim LocalizedName As String
Dim returnValue As Integer

returnValue = instance.RegisterExtenderProvider(ExtenderCATID, _
    ExtenderName, ExtenderProvider, _
    LocalizedName)

int RegisterExtenderProvider(
    string ExtenderCATID,
    string ExtenderName,
    IExtenderProvider ExtenderProvider,
    string LocalizedName
)

int RegisterExtenderProvider(
    [InAttribute] String^ ExtenderCATID, 
    [InAttribute] String^ ExtenderName, 
    [InAttribute] IExtenderProvider^ ExtenderProvider, 
    [InAttribute] String^ LocalizedName
)

function RegisterExtenderProvider(
    ExtenderCATID : String, 
    ExtenderName : String, 
    ExtenderProvider : IExtenderProvider, 
    LocalizedName : String
) : int

パラメータ

ExtenderCATID
型 : System.String

必ず指定します。エクステンダ CATID。

ExtenderName
型 : System.String

必ず指定します。エクステンダの名前。この名前はエクステンダのプログラミング名であり、GetExtender の呼び出しで使用されます。

ExtenderProvider
型 : EnvDTE.IExtenderProvider

必ず指定します。IExtenderProvider インターフェイスを実装する拡張プロバイダ。

LocalizedName
型 : System.String

省略可能です。エクステンダのローカライズされた表示名。

戻り値

型 : System.Int32

登録を識別する整数値の Cookie。この Cookie は、UnregisterExtenderProvider の実行時に送り返す必要があります。

解説

RegisterExtenderProvider は、拡張プロバイダによって使用され、その拡張プロバイダ自体を特定の CATID と名前で ObjectExtenders オブジェクトに動的に登録します。拡張プロバイダは、1 つ以上の CATID で複数のエクステンダを登録できます。

拡張プロバイダを登録するには、次の 2 つの方法があります。

アドインのインストール時に、レジストリキー HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0\Extenders の適切なエクステンダ CATID サブキーに静的に登録する。

アドインの OnConnection メソッドでこのメソッドを呼び出すことによって動的に登録する。

メモ :
動的に登録した拡張プロバイダは、シャットダウン時に UnregisterExtenderProvider を呼び出して登録を解除する必要があります。静的に登録したプロバイダでは、この操作を行わないでください。