Share via


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("B8C3E2D9-B807-4CCB-96E0-8B1C4E00D34A")> _
Public Interface VCCodeVariable
[GuidAttribute("B8C3E2D9-B807-4CCB-96E0-8B1C4E00D34A")]
public interface VCCodeVariable
[GuidAttribute(L"B8C3E2D9-B807-4CCB-96E0-8B1C4E00D34A")]
public interface class VCCodeVariable
[<GuidAttribute("B8C3E2D9-B807-4CCB-96E0-8B1C4E00D34A")>]
type VCCodeVariable =  interface end
public interface VCCodeVariable

The VCCodeVariable type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method GetEndPoint Gets a TextPoint object that marks the end of the code element definition.
Public method GetStartPoint Gets a TextPoint object that defines the beginning of the code element definition.
Public method 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