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

NameDescription
System_CAPS_pubpropertyAttributes

Gets a collection of all of the attributes for the object.

System_CAPS_pubpropertyBodyText

Gets or sets the body text of the object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Gets the collection containing the object supporting this property or contained within this code construct.

System_CAPS_pubpropertyComment

Gets or sets the comment associated with the code element.

System_CAPS_pubpropertyDeclarationText

Gets or sets the declaration of the object.

System_CAPS_pubpropertyDisplayName

Gets the name used in the user interface for this output group.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

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

System_CAPS_pubpropertyEndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the parent object.

System_CAPS_pubpropertyEnums

Gets a collection of enumerations for the object.

System_CAPS_pubpropertyExtender[String]

Gets the requested Extender object if it is available for this object.

System_CAPS_pubpropertyExtenderCATID

Gets the Extender category ID (CATID) for the object.

System_CAPS_pubpropertyExtenderNames

Gets a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file where this object is defined.

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.

System_CAPS_pubpropertyFunctions

Gets a collection of functions for the object.

System_CAPS_pubpropertyIDLCoClasses

Gets the collection of CoClass statements from the .idl file of the parent object.

System_CAPS_pubpropertyIDLImportLibs

Gets the collection of importlib statements from the .idl file of the parent object.

System_CAPS_pubpropertyInfoLocation

Describes the capabilities of the code model.

System_CAPS_pubpropertyInterfaces

Gets the collection of interfaces for the parent object.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

System_CAPS_pubpropertyIsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

System_CAPS_pubpropertyIsInjected

Gets a value indicating whether a code element has been injected by an attribute or macro expansion.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the file containing the object is read-only.

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the object no longer exists.

System_CAPS_pubpropertyKind

Gets an enumeration indicating the type of object.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyLocation[vsCMWhere]

Gets the location of the object declaration.

System_CAPS_pubpropertyMembers

Gets a collection of items contained by this element.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyPicture

Gets a picture automation object to be used as an icon in the user interface.

System_CAPS_pubpropertyProject

Gets the Project object associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyStartPoint

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

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

System_CAPS_pubpropertyStructs

Gets the collection of structure elements for the object.

System_CAPS_pubpropertyTypedefs

Gets the collection of typedef elements for the object.

System_CAPS_pubpropertyUnions

Gets the collection of Union elements for the object.

System_CAPS_pubpropertyVariables

Gets the collection of variables for the object.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddEnum(String, Object, Object, vsCMAccess)

Creates a new enumeration code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddFunction(String, vsCMFunction, Object, Object, vsCMAccess)

Creates a new function code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddIDLCoClass(String, Object)

Adds a new CoClass statement to the .idl file of the object.

System_CAPS_pubmethodAddIDLImportLib(String, Object)

Adds a new importlib statement to the .idl file of the object.

System_CAPS_pubmethodAddInterface(String, Object, Object, vsCMAccess)

Creates a new interface code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddStruct(String, Object, Object, Object, vsCMAccess)

Creates a new structure code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddTypedef(String, Object, Object, vsCMAccess)

Adds a typedef statement to the parent object.

System_CAPS_pubmethodAddUnion(String, Object, vsCMAccess)

Adds a union statement to the object.

System_CAPS_pubmethodAddVariable(String, Object, Object, vsCMAccess)

Creates a new variable code construct and inserts the code in the correct location.

System_CAPS_pubmethodGetEndPoint(vsCMPart)

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

System_CAPS_pubmethodGetStartPoint(vsCMPart)

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

System_CAPS_pubmethodIsSelf(Object)

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

System_CAPS_pubmethodValidateMember(String, vsCMElement, String)

Validates that the proposed name is a valid C++ name for the kind given in the context of the object.

System_CAPS_pubmethodValidateMemberName(String, vsCMElement, vcCMNameValidationOption)

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
Return to top
Show: