VCCodeIDLLibrary Interface

An object defining a library element in an .idl file.

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

Syntax

'Declaration
<GuidAttribute("1853C142-E8A8-421E-9DB5-B756E03167B8")> _
Public Interface VCCodeIDLLibrary
[GuidAttribute("1853C142-E8A8-421E-9DB5-B756E03167B8")]
public interface VCCodeIDLLibrary
[GuidAttribute(L"1853C142-E8A8-421E-9DB5-B756E03167B8")]
public interface class VCCodeIDLLibrary
[<GuidAttribute("1853C142-E8A8-421E-9DB5-B756E03167B8")>]
type VCCodeIDLLibrary =  interface end
public interface VCCodeIDLLibrary

The VCCodeIDLLibrary type exposes the following members.

Properties

  Name Description
Public property Attributes Gets a collection of all of the attributes for the object.
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 CodeModel Gets 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 DisplayName Gets the name used in the user interface for this output group.
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 parent object.
Public property Enums Gets a collection of enumerations for the object.
Public property Extender Gets 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 IDLCoClasses Gets the collection of CoClass statements from the .idl file of the parent object.
Public property IDLImportLibs Gets the collection of importlib statements from the .idl file of the parent object.
Public property InfoLocation Describes the capabilities of the code model.
Public property Interfaces Gets the collection of interfaces for the parent object.
Public property IsCaseSensitive Gets a value indicating whether 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 IsInjected Gets a value indicating whether a code element has been injected by an attribute or macro expansion.
Public property IsReadOnly Gets a value indicating whether the file containing the object is read-only.
Public property IsZombie Gets a value indicating whether the object no longer 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 Gets 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 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 object associated with the object.
Public property ProjectItem Gets the ProjectItem object associated with the given object.
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 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 AddEnum Creates a new enumeration code construct and inserts the code in the correct location.
Public method AddFunction Creates a new function code construct and inserts the code in the correct location.
Public method AddIDLCoClass Adds a new CoClass statement to the .idl file of the object.
Public method AddIDLImportLib Adds a new importlib statement to the .idl file of the object.
Public method AddInterface Creates a new interface 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 AddTypedef Adds a typedef statement to the parent 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 another code element.
Public method ValidateMember Validates that the proposed name is a valid C++ name for the kind given in the context of the object.

Top

Remarks

The VCCodeIDLLibrary object represents a library code element from the .idl file of the parent solution. Primarily, the object is used to access or modify the elements of an existing library 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 library code statement and displays it in a message box.

Sub GetFirstIDLLibrary()
    Dim vcCM As VCCodeModel
    Dim vcIDLLibrary As VCCodeIDLLibrary
    vcCM = DTE.Solution.Item(1).CodeModel
    vcIDLLibrary = vcCM.IDLLibraries.Item(1)
    MsgBox(vcIDLLibrary.DisplayName)
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace