VCCodeInterface Interface

An object representing either a standard .idl interface, a dispinterface code element, or a code element (modified by the __interface keyword) in the source code of a solution.

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

Syntax

'Declaration
<GuidAttribute("A572B53D-74FB-4395-89AC-B6E662BF0A64")> _
Public Interface VCCodeInterface

[GuidAttribute("A572B53D-74FB-4395-89AC-B6E662BF0A64")]
public interface VCCodeInterface

[GuidAttribute(L"A572B53D-74FB-4395-89AC-B6E662BF0A64")]
public interface class VCCodeInterface

[<GuidAttribute("A572B53D-74FB-4395-89AC-B6E662BF0A64")>]
type VCCodeInterface =  interface end

public interface VCCodeInterface

The VCCodeInterface type exposes the following members.

Properties

	Name	Description
	Access	Gets or sets the access attributes of this item.
	Attributes	Gets a collection of all of the attributes for the object.
	Bases	Gets a collection of classes from which this item derives.
	BodyText	Gets or sets the body text of 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.
	DerivedTypes	Gets a collection of objects derived from this object.
	DisplayName	Gets the full name of the object.
	DocComment	Gets or sets 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	Gets the end point of the object.
	Extender	Gets 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 in which the object is declared.
	FullName	Gets the full path and name of the object's file.
	Functions	Gets a collection of functions for the object.
	InfoLocation	Gets the capabilities of the code model.
	IsCaseSensitive	Gets a value indicating whether the current language is case-sensitive.
	IsCodeType	Gets a value indicating whether a CodeType object can be obtained from this object.
	IsDerivedFrom	Gets a value indicating whether an object has another object as a base.
	IsInjected	Gets a value indicating whether a code element has been injected by an attribute or macro expansion.
	IsManaged	Gets or sets a value indicating whether the object is managed.
	IsReadOnly	Gets a value indicating whether the file containing the object is read-only.
	IsZombie	Gets a value indicating whether the object no longer exists.
	Kind	Gets an enumeration indicating the type of object.
	Language	Gets the programming language used to author the code.
	Location	Gets the location of the object declaration.
	Members	Gets a collection of items contained by this element.
	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.
	References	Not currently implemented.
	StartPoint	Gets a TextPoint object that defines the beginning of the code item.
	StartPointOf	Gets the start point of the object.
	Variables	Gets the collection of variables for the object.

Top

Methods

	Name	Description
	AddAttribute	Creates a new attribute code construct and inserts the code in the correct location.
	AddBase	Adds an item to the list of inherited objects.
	AddFunction	Creates a new function code construct and inserts the code in the correct location.
	AddProperty	Creates a new property code construct and inserts the code in the correct location.
	AddVariable	Creates a new variable 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 another code element.
	RemoveBase	Removes an object from the list of bases.
	RemoveMember	Removes a member code construct.
	ValidateMember	Validates that the proposed name is a valid C++ name for the kind given in the context of the parent object.

Top

Remarks

The VCCodeInterface object represents an interface code element. Primarily, the object is used to access or modify the elements of an existing interface.

Note

A large part of the functionality of this object is provided by the Visual Studio CodeInterface object. For more information, see CodeInterface 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 the first VCCodeInterface object of the current solution and displays it in a message box. It assumes a project containing interfaces is open.

[Visual Basic]

Sub GetFirstInterface()
    Dim vcCM As VCCodeModel
    Dim vcInterface As VCCodeInterface
    vcCM = DTE.Solution.Item(1).CodeModel
    vcInterface = vcCM.Interfaces.Item(1)
    MsgBox(vcInterface.DisplayName)
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace