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
	Attributes	Gets a collection of all of the attributes for the object.
	BodyText	Gets or sets the body text of the object.
	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.
	DeclarationText	Gets or sets the declaration of the object.
	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	Gets the end point of the parent object.
	Enums	Gets a collection of enumerations for 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.
	Functions	Gets a collection of functions for the object.
	IDLCoClasses	Gets the collection of CoClass statements from the .idl file of the parent object.
	IDLImportLibs	Gets the collection of importlib statements from the .idl file of the parent object.
	InfoLocation	Describes the capabilities of the code model.
	Interfaces	Gets the collection of interfaces for the parent object.
	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.
	Members	Gets a collection of items contained by this element.
	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 object 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.
	Structs	Gets the collection of structure elements for the object.
	Typedefs	Gets the collection of typedef elements for the object.
	Unions	Gets the collection of Union elements for the object.
	Variables	Gets the collection of variables for the object.

Top

Methods

	Name	Description
	AddAttribute	Creates a new attribute code construct and inserts the code in the correct location.
	AddEnum	Creates a new enumeration code construct and inserts the code in the correct location.
	AddFunction	Creates a new function code construct and inserts the code in the correct location.
	AddIDLCoClass	Adds a new CoClass statement to the .idl file of the object.
	AddIDLImportLib	Adds a new importlib statement to the .idl file of the object.
	AddInterface	Creates a new interface code construct and inserts the code in the correct location.
	AddStruct	Creates a new structure code construct and inserts the code in the correct location.
	AddTypedef	Adds a typedef statement to the parent object.
	AddUnion	Adds a union statement to the object.
	AddVariable	Creates a new variable code construct and inserts the code in the correct location.
	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	Determines if the specified code element is the same as another code element.
	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