VCCodeVariable Interface

An object representing a variable construct in a source file.

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

Syntax

'Declaration
<GuidAttribute("0140C925-9BD8-4EBE-9AF8-ED9922947E45")> _
Public Interface VCCodeVariable

[GuidAttribute("0140C925-9BD8-4EBE-9AF8-ED9922947E45")]
public interface VCCodeVariable

[GuidAttribute(L"0140C925-9BD8-4EBE-9AF8-ED9922947E45")]
public interface class VCCodeVariable

[<GuidAttribute("0140C925-9BD8-4EBE-9AF8-ED9922947E45")>]
type VCCodeVariable =  interface end

public interface VCCodeVariable

The VCCodeVariable type exposes the following members.

Properties

	Name	Description
	Access	Sets or gets the access attributes of this item.
	Attributes	Gets a collection of all of the attributes for the object.
	Children	Gets a collection of objects contained within this code construct.
	CodeModel	Gets the VCCodeModel object for the project.
	Collection	Gets the collection containing the object supporting this property or contained within this code construct.
	Comment	Gets or sets the comment associated with the code element.
	DeclarationText	Gets or sets the declaration of the object.
	DisplayName	Gets the name used in the user interface for this output group.
	DocComment	Gets the document comment for the current code model element.
	DTE	Gets the top-level extensibility object.
	EndPoint	Gets the edit point that is the location of the end of the code item.
	EndPointOf	Returns the end point of the object.
	Extender	Returns the requested Extender object if it is available for this object.
	ExtenderCATID	Gets the Extender category ID (CATID) for the object.
	ExtenderNames	Gets a list of available Extenders for the object.
	File	Gets the file where this object is defined.
	FullName	Gets the full path and name of the object's file.
	InfoLocation	Gets the capabilities of the code model.
	InitExpression	Gets or sets an object defining the initialization code for an element.
	IsCaseSensitive	Gets a value indicating whether a code element is case-sensitive.
	IsCodeType	Gets a value indicating whether a CodeType object can be obtained from this object.
	IsConstant	Sets or gets whether the item is a constant.
	IsInjected	Gets if a code element has been injected by an attribute.
	IsReadOnly	Determines if the file containing the object is read-only.
	IsShared	Gets or sets a value indicating whether or not the item is statically defined, that is, if the item is common to all instances of this object type, or only to this object specifically.
	IsVolatile	Gets or sets a value indicating whether the volatile keyword is used.
	IsZombie	Gets if the object exists.
	Kind	Gets an enumeration indicating the type of object.
	Language	Gets the programming language used to author the code.
	Location	The location of the object declaration.
	Name	Gets or sets the name of the object.
	Namespace	Gets an object defining the namespace.
	Parent	Gets the immediate parent object of a given object.
	Picture	Gets a picture automation object to be used as an icon in the user interface.
	Project	Gets the Project object associated with the object.
	ProjectItem	Gets the ProjectItem object associated with the given object.
	Prototype	Returns a string holding the stub definition of this object.
	References	Not currently implemented.
	StartPoint	Gets a TextPoint object that defines the beginning of the code item.
	StartPointOf	Returns the start point of the object.
	Type	Gets or sets an object representing the programmatic type.
	TypeString	Gets or sets the type of the object using a string representation of the type.

Top

Methods

	Name	Description
	AddAttribute	Creates a new attribute code construct and inserts the code in the correct location.
	GetEndPoint	Gets a TextPoint object that marks the end of the code element definition.
	GetStartPoint	Gets a TextPoint object that defines the beginning of the code element definition.
	IsSelf	Determines if the specified code element is the same as the current code element.

Top

Remarks

The VCCodeVariable object is used to modify an existing variable construct.

Note

A large part of the functionality of this object is provided by the Visual Studio CodeVariable object. For more information, see CodeVariable object.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

Examples

This example retrieves all variables of the current solution and displays each name in a message box. It assumes a default MFC project is open.

Sub GetAllVars()
    Dim vcCM As VCCodeModel
    Dim vcVar As VCCodeVariable
    vcCM = DTE.Solution.Item(1).CodeModel
    For Each vcVar in vcCM.Variables
        MsgBox(vcVar.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace