CodeClass2.AddFunction メソッド (String, vsCMFunction, Object, Object, vsCMAccess, Object)

[アーティクル]
08/09/2011

クラスに新しい関数を作成します。

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

構文

'宣言
Function AddFunction ( _
    Name As String, _
    Kind As vsCMFunction, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeFunction

CodeFunction AddFunction(
    string Name,
    vsCMFunction Kind,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeFunction^ AddFunction(
    String^ Name, 
    vsCMFunction Kind, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddFunction : 
        Name:string * 
        Kind:vsCMFunction * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeFunction

function AddFunction(
    Name : String, 
    Kind : vsCMFunction, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeFunction

パラメーター

Name
型: System.String
必須。新しい関数の名前。

Kind
型: EnvDTE.vsCMFunction
必須。関数の種類 (プロパティの Getter やメソッドなど) を示す vsCMFunction 定数。

Type
型: System.Object
必須。関数で返されるデータ型を示す vsCMTypeRef 定数。CodeTypeRef オブジェクト、vsCMTypeRef 定数、または完全修飾型名のいずれかになります。

Position
型: System.Object
省略可能です。既定値は 0 です。ここで指定したコード要素の後に、新しい関数を追加します。
値が long 型の場合は、後ろに新しい要素を追加する要素が Position によって示されます。
コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値が-1 の場合は関数を末尾に配置することを示します。

Access
型: EnvDTE.vsCMAccess
省略可能です。定数 vsCMAccess。

Location
型: System.Object
省略可能です。新しい関数の位置を指定します。

戻り値

型: EnvDTE.CodeFunction
CodeFunction オブジェクト。

実装

CodeClass.AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

解説

ネイティブな Visual C++ では、コロン区切り形式 (::) で完全修飾型名を指定する必要があります。他のすべての言語では、ピリオド区切りの書式がサポートされます。

引数が正しいかどうかは、コードモデルの背後にある言語によって決まります。

注意

特定の種類の編集を行うと、クラス、構造体、関数、属性、デリゲートなどのコードモデル要素が非確定的な値になる場合があります。つまり、これらの要素の値は、常に同じ値になるとは限りません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」で、コードモデル要素値を変更する方法についての説明を参照してください。

例

[Visual Basic]

Sub AddFunctionExample2(ByVal dte As DTE2)
    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Create a new member function.
        cls.AddFunction("TestFunction", _
            vsCMFunction.vsCMFunctionFunction, _
            vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

public void AddFunctionExample2(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Create a new member function.
        cls.AddFunction("TestFunction", 
            vsCMFunction.vsCMFunctionFunction, 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
            vsCMAccess.vsCMAccessDefault, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}