CodeStruct.AddVariable Method

Creates a new variable code construct and inserts the code in the correct location.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
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

Parameters

• Name
  Type: System.String

  Required. The name of the new variable.

• Type
  Type: System.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
  Type: System.Object

  Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

  If the value is a Long data type, then AddVariable 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 that the element should be placed at the end.

• Access
  Type: EnvDTE.vsCMAccess

  Optional. A vsCMAccess constant.

• Location
  Type: System.Object

  Optional. The path and file name for the new variable definition. Depending on the language, the path to the project file is either relative or absolute. 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 fails.

Return Value

Type: EnvDTE.CodeVariable
A CodeVariable object.

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).

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CodeStruct Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)