Share via


VCCodeIDLImport Interface

Definition

An object defining an import element in an .idl file.

public interface class VCCodeIDLImport
public interface class VCCodeIDLImport
__interface VCCodeIDLImport
[System.Runtime.InteropServices.Guid("84980391-8CC2-46F0-A932-74A2D5E0A49E")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeIDLImport
[<System.Runtime.InteropServices.Guid("84980391-8CC2-46F0-A932-74A2D5E0A49E")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeIDLImport = interface
Public Interface VCCodeIDLImport
Attributes

Examples

This example retrieves the first import code statement and displays it in a message box.

Sub GetFirstIDLImport()  
    Dim vcCM As VCCodeModel  
    Dim vcIDLImport As VCCodeIDLImport  
    vcCM = DTE.Solution.Item(1).CodeModel  
    vcIDLImport = vcCM.IDLImports.Item(1)  
    MsgBox(vcIDLImport.DisplayName)  
End Sub  

Remarks

The VCCodeIDLImport object represents an import code element from the .idl file of the parent solution. Primarily, the object is used to access existing import code elements.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

Properties

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 name used in the user interface for this output group.

DTE

Gets the top-level extensibility object.

EndPoint

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

EndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the parent object.

Extender[String]

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 parent exists.

Kind

Gets an enumeration indicating the type of object.

Language

Gets the programming language used to author the code.

Location[vsCMWhere]

Gets the location of the object declaration.

Name

Gets or sets the name of the object.

Parent

Gets the immediate 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 Project object associated with the given object.

StartPoint

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

StartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the parent object.

Methods

GetEndPoint(vsCMPart)

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

GetStartPoint(vsCMPart)

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

IsSelf(Object)

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

Applies to