CodeFunction.AddParameter メソッド

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

更新 : 2007 年 11 月

新しいパラメータコード構成を作成し、適切な位置にコードを挿入します。

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

構文

'宣言
Function AddParameter ( _
    Name As String, _
    Type As Object, _
    Position As Object _
) As CodeParameter
'使用
Dim instance As CodeFunction
Dim Name As String
Dim Type As Object
Dim Position As Object
Dim returnValue As CodeParameter

returnValue = instance.AddParameter(Name, _
    Type, Position)

CodeParameter AddParameter(
    string Name,
    Object Type,
    Object Position
)

CodeParameter^ AddParameter(
    String^ Name, 
    Object^ Type, 
    Object^ Position
)

function AddParameter(
    Name : String, 
    Type : Object, 
    Position : Object
) : CodeParameter

パラメータ

Name
型 : System.String

必ず指定します。パラメータの名前。

Type
型 : System.Object

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

Position
型 : System.Object

(省略可能) 既定では 0 が指定されます。ここで指定したコード要素の後に、新しい要素を追加します。値が CodeElement の場合は、その値の直後に新しい要素が追加されます。

値が long 型の場合は、後ろに新しい要素を追加する要素が AddParameter によって示されます。

コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値 -1 は要素を末尾に配置することを示します。

戻り値

型 : EnvDTE.CodeParameter

CodeParameter オブジェクト。

解説

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

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

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

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

例

 Sub AddParameterExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a function.
    Try
        ' Retrieve the CodeFunction at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim fun As CodeFunction = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementFunction), CodeFunction)

        ' Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

 public void AddParameterExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a function.
    try
    {
        // Retrieve the CodeFunction at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeFunction fun = 
            (CodeFunction)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementFunction);

        // Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt, -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}