Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)

[GuidAttribute("B11D9FC0-85D6-4B59-9499-6DC815509B33")]
public interface VCCodeIDLLibrary

The VCCodeIDLLibrary type exposes the following members.

  NameDescription
Public propertyAttributesGets a collection of all of the attributes for the object.
Public propertyBodyTextGets or sets the body text of the object.
Public propertyChildrenGets a collection of objects contained within this code construct.
Public propertyCodeModelGets the VCCodeModel object for the project.
Public propertyCollectionGets the collection containing the object supporting this property or contained within this code construct.
Public propertyCommentGets or sets the comment associated with the code element.
Public propertyDeclarationTextGets or sets the declaration of the object.
Public propertyDisplayNameGets the name used in the user interface for this output group.
Public propertyDTEGets the top-level extensibility object.
Public propertyEndPointGets the edit point that is the location of the end of the code item.
Public propertyEndPointOfGets the end point of the parent object.
Public propertyEnumsGets a collection of enumerations for the object.
Public propertyExtenderGets the requested Extender object if it is available for this object.
Public propertyExtenderCATIDGets the Extender category ID (CATID) for the object.
Public propertyExtenderNamesGets a list of available Extenders for the object.
Public propertyFileGets the file where this object is defined.
Public propertyFullNameGets the full path and name of the object's file.
Public propertyFunctionsGets a collection of functions for the object.
Public propertyIDLCoClassesGets the collection of CoClass statements from the .idl file of the parent object.
Public propertyIDLImportLibsGets the collection of importlib statements from the .idl file of the parent object.
Public propertyInfoLocationDescribes the capabilities of the code model.
Public propertyInterfacesGets the collection of interfaces for the parent object.
Public propertyIsCaseSensitiveGets a value indicating whether a code element is case-sensitive.
Public propertyIsCodeTypeGets a value indicating whether a CodeType object can be obtained from this object.
Public propertyIsInjectedGets a value indicating whether a code element has been injected by an attribute or macro expansion.
Public propertyIsReadOnlyGets a value indicating whether the file containing the object is read-only.
Public propertyIsZombieGets a value indicating whether the object no longer exists.
Public propertyKindGets an enumeration indicating the type of object.
Public propertyLanguageGets the programming language used to author the code.
Public propertyLocationGets the location of the object declaration.
Public propertyMembersGets a collection of items contained by this element.
Public propertyNameGets or sets the name of the object.
Public propertyParentGets the immediate parent object of a given object.
Public propertyPictureGets a picture automation object to be used as an icon in the user interface.
Public propertyProjectGets the Project object associated with the object.
Public propertyProjectItemGets the ProjectItem object associated with the given object.
Public propertyStartPointGets a TextPoint object that defines the beginning of the code item.
Public propertyStartPointOfGets the start point of the object.
Public propertyStructsGets the collection of structure elements for the object.
Public propertyTypedefsGets the collection of typedef elements for the object.
Public propertyUnionsGets the collection of Union elements for the object.
Public propertyVariablesGets the collection of variables for the object.
Top

  NameDescription
Public methodAddAttributeCreates a new attribute code construct and inserts the code in the correct location.
Public methodAddEnumCreates a new enumeration code construct and inserts the code in the correct location.
Public methodAddFunctionCreates a new function code construct and inserts the code in the correct location.
Public methodAddIDLCoClassAdds a new CoClass statement to the .idl file of the object.
Public methodAddIDLImportLibAdds a new importlib statement to the .idl file of the object.
Public methodAddInterfaceCreates a new interface code construct and inserts the code in the correct location.
Public methodAddStructCreates a new structure code construct and inserts the code in the correct location.
Public methodAddTypedefAdds a typedef statement to the parent object.
Public methodAddUnionAdds a union statement to the object.
Public methodAddVariableCreates a new variable code construct and inserts the code in the correct location.
Public methodGetEndPointGets a TextPoint object that marks the end of the code element definition.
Public methodGetStartPointGets a TextPoint object that defines the beginning of the code element definition.
Public methodIsSelfDetermines if the specified code element is the same as another code element.
Public methodValidateMemberValidates that the proposed name is a valid C++ name for the kind given in the context of the object.
Public methodValidateMemberName
Top

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.

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft