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

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 code construct and inserts the code in the correct location.

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

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

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

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

Parameters

Name: String

Required. The name of the new variable.

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

Type: 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(String, Object, Object, Object, vsCMAccess) 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.

Position: Object

Optional. A vsCMAccess constant.

Access: vsCMAccess

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, Object, vsCMAccess) fails.

Returns

CodeVariable

A CodeVariable object.

Implements

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

Attributes: DispIdAttribute

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.

Applies to

Partilhar via