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

Article
09/25/2012

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

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

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

'Usage
Dim instance As VCCodeModel 
Dim Name As String 
Dim Location As Object 
Dim Type As Object 
Dim Position As Object 
Dim Access As vsCMAccess 
Dim returnValue As CodeVariable 

returnValue = instance.AddVariable(Name, _
    Location, Type, Position, Access)

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

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

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

Parameters

Name
Type: System.String

Required. The name of the new variable.

Location
Type: System.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 fails.

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 the element should be placed at the end.

Access
Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeVariable
A CodeVariable object.

Implements

CodeModel2.AddVariable(String, Object, Object, Object, vsCMAccess)

Remarks

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.

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