CodeModel.AddFunction 方法

發行項
10/28/2012

建立新的函式程式碼建構，並在正確位置插入程式碼。

命名空間： EnvDTE
組件： EnvDTE (在 EnvDTE.dll 中)

語法

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

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

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

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

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

參數

Name
型別：System.String
必要項。新函式的名稱。

Location
型別：System.Object
必要項。新函式定義的路徑和檔名。根據程式語言的不同，檔名可能與專案檔相關或完全一致。如果這個檔案目前不是專案項目，將會將它加入到專案中。如果無法建立這個檔案並加入至專案，則 AddFunction 將會失敗。

Kind
型別：EnvDTE.vsCMFunction
必要項。指示函式型別 (例如該函式是 property-get 或方法等) 的 vsCMFunction 常數。

Type
型別：System.Object
必要項。vsCMTypeRef 常數，表示函式所傳回的資料型別。這可以是 CodeTypeRef 物件、vsCMTypeRef 常數或完整型別名稱。

Position
型別：System.Object
選擇項。預設値 = 0。其後要加入新項目的程式碼項目。如果這個值是 CodeElement，則會緊接在其後加入新項目。
如果這個值是長資料型別，那麼 AddFunction 會指示其後要加入新項目的項目。
由於集合是從 1 開始計算，傳遞 0 表示新的項目必須放在集合起始的位置。值為 -1 時表示這個項目必須放在結尾。

Access
型別：EnvDTE.vsCMAccess
選擇項。vsCMAccess 常數。

傳回值

型別：EnvDTE.CodeFunction
CodeFunction 物件。

備註

以下程式碼使用 vsCMFunction.vsCMFunctionOperator 加入多載運算子。

Sub testAddOverloadOperatorCPP()

Dim fcm As FileCodeModel = _

DTE.ActiveDocument.ProjectItem.FileCodeModel

Dim cc As CodeClass = fcm.CodeElements.Item("someClassName")

cc.AddFunction("+", vsCMFunction.vsCMFunctionOperator, _

vsCMTypeRef.vsCMTypeRefInt)

'cc.AddFunction("someFunction +", _

vsCMFunction.vsCMFunctionFunction, vsCMTypeRef.vsCMTypeRefInt)

End Sub

在這個執行個體中，您必須在呼叫 AddFunction 時，明確指定要多載的函式名稱 (在此處為 "someFunction")，而非僅多載運算子本身。

以上方的程式碼為例，cc.AddFunction("+", vsCMFunction.vsCMFunctionOperator,...) 無效。您必須改用 cc.AddFunction("someFunction +", vsCMFunction.vsCMFunctionFunction,...)

僅 Visual C++ 實作 AddFunction，因為 C#、Visual Basic 和 J# 不允許最上層函式。

原生 Visual C++ 的完整型別名稱必須使用冒號 (::) 分隔。

注意事項
在特定類型的編輯之後，程式碼模型項目 (例如類別、結構、函式、屬性、委派等) 的值可能不具決定性，表示其值不一定維持相同。如需詳細資訊，請參閱使用程式碼模型探索程式碼 (Visual Basic) 的＜程式碼模型項目值可以變更＞一節。

範例

Sub AddFunctionExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

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

End Sub

public void AddFunctionExample(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

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