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)

[GuidAttribute("64793BC0-42F2-4ADF-A285-D4A4247E191B")]
public interface VCCodeStruct

NameDescription
System_CAPS_pubpropertyAccess

Defines the access attributes of this item.

System_CAPS_pubpropertyAttributes

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

System_CAPS_pubpropertyBases

Gets a collection of classes from which this item derives.

System_CAPS_pubpropertyBodyText

Gets or sets the body text of the object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyClasses

Gets a collection of classes for the parent object.

System_CAPS_pubpropertyCodeModel

Returns 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_pubpropertyDataTypeKind

System_CAPS_pubpropertyDeclarationText

Gets or sets the declaration of the object.

System_CAPS_pubpropertyDerivedTypes

Gets a collection of objects derived from this object.

System_CAPS_pubpropertyDisplayName

Gets the full name of the object.

System_CAPS_pubpropertyDocComment

Gets or sets 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]

Gets the end point of the object.

System_CAPS_pubpropertyEnums

Gets a collection of enumerations for the object.

System_CAPS_pubpropertyEvents

Gets a collection of events for 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_pubpropertyFunctions

Gets a collection of functions for the object.

System_CAPS_pubpropertyImplementedInterfaces

Gets a collection of interfaces implemented by this object.

System_CAPS_pubpropertyInfoLocation

Describes the capabilities of the code model.

System_CAPS_pubpropertyIsAbstract

Gets or sets a value indicating whether or not an item is declared as abstract.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value indicating if 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_pubpropertyIsDerivedFrom[String]

Gets a value indicating whether an object has another object as a base.

System_CAPS_pubpropertyIsFinal

System_CAPS_pubpropertyIsInjected

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

System_CAPS_pubpropertyIsManaged

Sets or gets if the object is managed.

System_CAPS_pubpropertyIsReadOnly

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

System_CAPS_pubpropertyIsSealed

Sets or gets if the __sealed keyword is applied to the parent object.

System_CAPS_pubpropertyIsTemplate

Gets if the object is a template.

System_CAPS_pubpropertyIsValue

Sets or gets if the __value keyword is applied to the object.

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]

Returns the location of the object declaration.

System_CAPS_pubpropertyMembers

Gets a collection of items contained by this element.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the parent namespace.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyParts

System_CAPS_pubpropertyPicture

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

System_CAPS_pubpropertyProject

Gets the Project associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyProperties

Gets the collection of properties for the 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]

Gets the start point of the object.

System_CAPS_pubpropertyStructs

Gets the collection of structure elements for the object.

System_CAPS_pubpropertyTemplateParameters

A collection of template parameters.

System_CAPS_pubpropertyTemplatizations

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyTypedefs

Gets the collection of Typedef elements for the object.

System_CAPS_pubpropertyUnions

Gets the collection of union elements for the object.

System_CAPS_pubpropertyUsingAliases

System_CAPS_pubpropertyVariables

Gets the collection of variables for the object.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

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

System_CAPS_pubmethodAddBase(Object, Object)

Adds an item to the list of inherited objects.

System_CAPS_pubmethodAddClass(String, Object, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddDelegate(String, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddEnum(String, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddEvent(String, Object, Object, vsCMAccess)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodAddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

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

System_CAPS_pubmethodAddImplementedInterface(Object, Object)

Adds an interface to the list of inherited objects.

System_CAPS_pubmethodAddProperty(String, String, Object, Object, vsCMAccess, Object)

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

System_CAPS_pubmethodAddStruct(String, Object, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddTemplateParameter(String, Object, Object)

Adds a parameter to a template definition.

System_CAPS_pubmethodAddTypedef(String, Object, Object, vsCMAccess)

Adds a typedef statement to the object.

System_CAPS_pubmethodAddUnion(String, Object, vsCMAccess)

Adds a union statement to the object.

System_CAPS_pubmethodAddUsingAlias(String, Object, Object, vsCMAccess)

System_CAPS_pubmethodAddVariable(String, Object, Object, vsCMAccess, Object)

Creates a new variable 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 parent code element.

System_CAPS_pubmethodRemoveBase(Object)

Removes an object from the list of bases.

System_CAPS_pubmethodRemoveInterface(Object)

Removes an interface from the list of implemented interfaces.

System_CAPS_pubmethodRemoveMember(Object)

Removes a member code construct.

System_CAPS_pubmethodRemoveTemplateParameter(Object)

Removes a parameter from a template definition.

System_CAPS_pubmethodValidateMember(String, vsCMElement, String)

Validates that the proposed name is a valid Visual C++ name for the kind given in the context of the parent object.

System_CAPS_pubmethodValidateMemberName(String, vsCMElement, vcCMNameValidationOption)

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

System_CAPS_noteNote

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

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