CodeClass2.AddVariable(String, Object, Object, vsCMAccess, Object) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a new variable in the class.

EnvDTE::CodeVariable AddVariable(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Type, winrt::Windows::Foundation::IInspectable const & Position, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, winrt::Windows::Foundation::IInspectable const & Location);

[System.Runtime.InteropServices.DispId(65)]
public EnvDTE.CodeVariable AddVariable (string Name, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, object Location);

[<System.Runtime.InteropServices.DispId(65)>]
abstract member AddVariable : string * obj * obj * EnvDTE.vsCMAccess * obj -> EnvDTE.CodeVariable

Public Function AddVariable (Name As String, Type As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault, Optional Location As Object) As CodeVariable

Parameters

Name: String

Required. The name of the new variable.

Type: Object

Required. A vsCMTypeRef constant indicating the data type that the function returns. This can be a CodeTypeRef object, a vsCMTypeRef constant, or a fully qualified type name.

Position: Object

Optional. Default = 0. The code element after which to add the new element.

If the value is a Long data type, then Position indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Access: vsCMAccess

Optional. A vsCMAccess constant.

Location: Object

Optional. The path and file name for the new variable definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddVariable(String, Object, Object, vsCMAccess, Object) fails.

Returns

CodeVariable

A CodeVariable object.

Implements

AddVariable(String, Object, Object, vsCMAccess, Object)

Attributes: DispIdAttribute

Examples

[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);  
    }  
}

Remarks

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Applies to

Udostępnij za pośrednictwem