VCCodeImport Interface
An object representing a #import 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("E6CC47B0-2298-4689-8774-7F8D6A361D73")> _
Public Interface VCCodeImport
[GuidAttribute("E6CC47B0-2298-4689-8774-7F8D6A361D73")]
public interface VCCodeImport
[GuidAttribute(L"E6CC47B0-2298-4689-8774-7F8D6A361D73")]
public interface class VCCodeImport
[<GuidAttribute("E6CC47B0-2298-4689-8774-7F8D6A361D73")>]
type VCCodeImport = interface end
public interface VCCodeImport
The VCCodeImport type exposes the following members.
Properties
Name | Description | |
---|---|---|
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. | |
DisplayName | Gets the full name of the object. | |
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 where this object is defined. | |
FullName | Gets the full path and name of the object's file. | |
InfoLocation | Gets the capabilities of the code model. | |
IsCaseSensitive | Gets a value indicating whether a code element is case-sensitive. | |
IsCodeType | Gets a value indicating whether a CodeType object can be obtained from this object. | |
IsInjected | Gets a value indicating whether a code element has been injected by an attribute or macro expansion. | |
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. | |
Name | Gets or sets the name of the object. | |
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 associated with the given object. | |
StartPoint | Gets a TextPoint object that defines the beginning of the code item. | |
StartPointOf | Gets the start point of the object. |
Top
Methods
Name | Description | |
---|---|---|
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 | Gets a value indicating whether the specified code element is the same as another code element. |
Top
Remarks
The VCCodeImport object represents a #import code statement in a source file, allowing access to information about the specific code element.
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 VCCodeImport object of the current solution and displays it in a message box. It assumes that a C++ project containing a #import statement is open.
Sub GetFirstImport()
Dim vcCM As VCCodeModel
Dim vcImport As VCCodeImport
vcCM = DTE.Solution.Item(1).CodeModel
vcImport = vcCM.Imports.Item(1)
MsgBox(vcImport.DisplayName)
End Sub