VCCodeNamespace::AddVariable Method (String^, Object^, Object^, vsCMAccess)

 

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)

CodeVariable^ AddVariable(
	String^ Name,
	Object^ Type,
	Object^ Position,
	vsCMAccess Access = vsCMAccess::vsCMAccessDefault
)

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

Access
Type: EnvDTE::vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE::CodeVariable^

A CodeVariable object.

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.

Return to top
Show: