VCCodeStruct Interface

An object representing a structure code element in the source code of a solution.

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

Syntax

'Declaration
<GuidAttribute("B3B2B528-ECD5-4DD0-808F-07EB265A1FD8")> _
Public Interface VCCodeStruct
[GuidAttribute("B3B2B528-ECD5-4DD0-808F-07EB265A1FD8")]
public interface VCCodeStruct
[GuidAttribute(L"B3B2B528-ECD5-4DD0-808F-07EB265A1FD8")]
public interface class VCCodeStruct
[<GuidAttribute("B3B2B528-ECD5-4DD0-808F-07EB265A1FD8")>]
type VCCodeStruct =  interface end
public interface VCCodeStruct

The VCCodeStruct type exposes the following members.

Properties

  Name Description
Public property Access Defines the access attributes of this item.
Public property Attributes Gets a collection of all of the attributes for the parent object.
Public property Bases Gets a collection of classes from which this item derives.
Public property BodyText Gets or sets the body text of the object.
Public property Children Gets a collection of objects contained within this code construct.
Public property Classes Gets a collection of classes for the parent object.
Public property CodeModel Returns 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 DerivedTypes Gets a collection of objects derived from this object.
Public property DisplayName Gets the full name of the object.
Public property DocComment Gets or sets 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 Gets the end point of the object.
Public property Enums Gets a collection of enumerations for the object.
Public property Events Gets a collection of events for 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 Functions Gets a collection of functions for the object.
Public property ImplementedInterfaces Gets a collection of interfaces implemented by this object.
Public property InfoLocation Describes the capabilities of the code model.
Public property IsAbstract Gets or sets a value indicating whether or not an item is declared as abstract.
Public property IsCaseSensitive Gets a value indicating if 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 IsDerivedFrom Gets a value indicating whether an object has another object as a base.
Public property IsInjected Gets if a code element has been injected by an attribute or macro expansion.
Public property IsManaged Sets or gets if the object is managed.
Public property IsReadOnly Gets if the file containing the object is read-only.
Public property IsSealed Sets or gets if the __sealed keyword is applied to the parent object.
Public property IsTemplate Gets if the object is a template.
Public property IsValue Sets or gets if the __value keyword is applied to the object.
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 Returns the location of the object declaration.
Public property Members Gets a collection of items contained by this element.
Public property Name Gets or sets the name of the object.
Public property Namespace Gets an object defining the parent 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 associated with the object.
Public property ProjectItem Gets the ProjectItem object associated with the given object.
Public property Properties Gets the collection of properties for the 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 Gets the start point of the object.
Public property Structs Gets the collection of structure elements for the object.
Public property TemplateParameters A collection of template parameters.
Public property Templatizations Infrastructure. Microsoft Internal Use Only.
Public property Typedefs Gets the collection of Typedef elements for the object.
Public property Unions Gets the collection of union elements for the object.
Public property Variables Gets the collection of variables for the object.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method AddBase Adds an item to the list of inherited objects.
Public method AddClass Creates a new class code construct and inserts the code in the correct location.
Public method AddDelegate Creates a new delegate code construct and inserts the code in the correct location.
Public method AddEnum Creates a new enumeration code construct and inserts the code in the correct location.
Public method AddEvent Infrastructure. Microsoft Internal Use Only.
Public method AddFunction Creates a new function code construct and inserts the code in the correct location.
Public method AddImplementedInterface Adds an interface to the list of inherited objects.
Public method AddProperty Creates a new property code construct and inserts the code in the correct location.
Public method AddStruct Creates a new structure code construct and inserts the code in the correct location.
Public method AddTemplateParameter Adds a parameter to a template definition.
Public method AddTypedef Adds a typedef statement to the object.
Public method AddUnion Adds a union statement to the object.
Public method AddVariable Creates a new variable 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 parent code element.
Public method RemoveBase Removes an object from the list of bases.
Public method RemoveInterface Removes an interface from the list of implemented interfaces.
Public method RemoveMember Removes a member code construct.
Public method RemoveTemplateParameter Removes a parameter from a template definition.
Public method ValidateMember Validates that the proposed name is a valid Visual C++ name for the kind given in the context of the parent object.

Top

Remarks

The VCCodeStruct object is used to modify an existing function construct.

Note

A large part of the functionality of this object is provided by the Visual Studio CodeStruct object. For more information, see CodeStruct 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 structure code elements of the current solution and displays each name in a message box.

[Visual Basic]

Sub GetAllStructs()
    Dim vcCM As VCCodeModel
    Dim vcStruct As VCCodeStruct
    vcCM = DTE.Solution.Item(1).CodeModel
    For Each vcStruct in vcCM.Structs
        MsgBox(vcStruct.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace