CodeClass2.AddVariable 方法 (String, Object, Object, vsCMAccess, Object)

發行項
10/28/2012

在類別中建立新變數。

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

語法

'宣告
Function AddVariable ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeVariable

CodeVariable AddVariable(
    string Name,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeVariable^ AddVariable(
    String^ Name, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddVariable : 
        Name:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeVariable

function AddVariable(
    Name : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeVariable

參數

Name
型別：System.String
必要項。新變數的名稱。

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

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

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

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

傳回值

型別：EnvDTE.CodeVariable
CodeVariable 物件。

備註

原生 Visual C++ 的完整型別名稱必須使用冒號 (::) 分隔。其他所有語言都支援句號 (.) 分隔的格式。

引數的正確性取決於程式碼模型後的程式語言。

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

範例

[C#]

public void CodeClass2AddVariableExample(DTE2 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.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls =
            (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        object pos = -1; // Place variable at end of members collection
        // Add variable to ActiveDocument.
        CodeVariable cvar = cls.AddVariable("TestAddVar",
            vsCMTypeRef.vsCMTypeRefFloat, pos,
            vsCMAccess.vsCMAccessProtected, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}