VCCodeVariable Interface

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)

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

NameDescription
System_CAPS_pubpropertyAccess

Sets or gets the access attributes of this item.

System_CAPS_pubpropertyAttributes

Gets a collection of all of the attributes for the object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Gets the collection containing the object supporting this property or contained within this code construct.

System_CAPS_pubpropertyComment

Gets or sets the comment associated with the code element.

System_CAPS_pubpropertyDeclarationText

Gets or sets the declaration of the object.

System_CAPS_pubpropertyDisplayName

Gets the name used in the user interface for this output group.

System_CAPS_pubpropertyDocComment

Gets the document comment for the current code model element.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

Gets the edit point that is the location of the end of the code item.

System_CAPS_pubpropertyEndPointOf[vsCMPart, vsCMWhere]

Returns the end point of the object.

System_CAPS_pubpropertyExtender[String]

Returns the requested Extender object if it is available for this object.

System_CAPS_pubpropertyExtenderCATID

Gets the Extender category ID (CATID) for the object.

System_CAPS_pubpropertyExtenderNames

Gets a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file where this object is defined.

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyInitExpression

Gets or sets an object defining the initialization code for an element.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

System_CAPS_pubpropertyIsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

System_CAPS_pubpropertyIsConstant

Sets or gets whether the item is a constant.

System_CAPS_pubpropertyIsInjected

Gets if a code element has been injected by an attribute.

System_CAPS_pubpropertyIsReadOnly

Determines if the file containing the object is read-only.

System_CAPS_pubpropertyIsShared

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.

System_CAPS_pubpropertyIsVolatile

Gets or sets a value indicating whether the volatile keyword is used.

System_CAPS_pubpropertyIsZombie

Gets if the object exists.

System_CAPS_pubpropertyKind

Gets an enumeration indicating the type of object.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyLocation[vsCMWhere]

The location of the object declaration.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyPicture

Gets a picture automation object to be used as an icon in the user interface.

System_CAPS_pubpropertyProject

Gets the Project object associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyPrototype[Int32]

Returns a string holding the stub definition of this object.

System_CAPS_pubpropertyReferences

Not currently implemented.

System_CAPS_pubpropertyStartPoint

Gets a TextPoint object that defines the beginning of the code item.

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Returns the start point of the object.

System_CAPS_pubpropertyType

Gets or sets an object representing the programmatic type.

System_CAPS_pubpropertyTypeString

Gets or sets the type of the object using a string representation of the type.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

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

System_CAPS_pubmethodGetEndPoint(vsCMPart)

Gets a TextPoint object that marks the end of the code element definition.

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Gets a TextPoint object that defines the beginning of the code element definition.

System_CAPS_pubmethodIsSelf(Object)

Determines if the specified code element is the same as the current code element.

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

System_CAPS_noteNote

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.

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
Return to top
Show:
© 2016 Microsoft