VCCodeFunction Interface

 

An object defining a function construct in a source file.

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

[GuidAttribute("E476F331-0B0B-47BC-8FA3-460353B95DC4")]
public interface VCCodeFunction

NameDescription
System_CAPS_pubpropertyAccess

Gets or sets the access attributes of this item.

System_CAPS_pubpropertyAttributes

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

System_CAPS_pubpropertyBodyText

Gets or sets the body text of the parent object.

System_CAPS_pubpropertyCanOverride

Gets or sets a value indicating whether or not the function can be overridden.

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_pubpropertyDocComment

Gets or sets the document comment for the current code model element.

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_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_pubpropertyFunctionKind

Gets an enumeration describing how a function is used.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

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_pubpropertyIsConstant

Gets or sets a value indicating whether or not the item is a constant.

System_CAPS_pubpropertyIsDefault

System_CAPS_pubpropertyIsDelete

System_CAPS_pubpropertyIsFinal

System_CAPS_pubpropertyIsInjected

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

System_CAPS_pubpropertyIsInline

Gets or sets the inline property of the function object.

System_CAPS_pubpropertyIsOverloaded

Gets a value indicating whether or not a function is overloaded.

System_CAPS_pubpropertyIsReadOnly

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

System_CAPS_pubpropertyIsSealed

Sets or gets the IsSealed keyword on a function.

System_CAPS_pubpropertyIsShared

Gets or sets a value indicating whether or not the item is statically defined, that is, if the item is common to all instances of this object type, or only to this object specifically.

System_CAPS_pubpropertyIsTemplate

Gets a value indicating whether the parent object is a template.

System_CAPS_pubpropertyIsVirtual

Gets or sets a value indicating whether the parent object is virtual.

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the object exists.

System_CAPS_pubpropertyKind

Gets an enumeration value 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_pubpropertyMustImplement

Gets or sets a value indicating whether or not the item is declared abstract and thus requires an implementation.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

System_CAPS_pubpropertyOverloads

Gets a collection of overloaded methods for this item.

System_CAPS_pubpropertyParameters

Gets a collection of parameters for this item.

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 associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyPrototype[Int32]

Gets a string holding the stub definition of this object.

System_CAPS_pubpropertyReferences

Not currently implemented.

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

System_CAPS_pubpropertyTemplateParameters

Gets a collection of parameters contained in a class template.

System_CAPS_pubpropertyTemplatizations

This API supports the product infrastructure and is not intended to be used directly from your code. Internal Microsoft Use Only.

System_CAPS_pubpropertyType

Gets or sets an object representing the programmatic type.

System_CAPS_pubpropertyTypeString

Gets or sets the type of object using a string representation of the type.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

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

System_CAPS_pubmethodAddInitializer(String)

Adds a C++ initializer to a constructor's member initializer list.

System_CAPS_pubmethodAddParameter(String, Object, Object)

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

System_CAPS_pubmethodAddTemplateParameter(String, Object, Object)

Adds a parameter to a template definition.

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 the parent code element.

System_CAPS_pubmethodRemoveParameter(Object)

Removes a parameter from the argument list.

System_CAPS_pubmethodRemoveTemplateParameter(Object)

Removes a parameter from a template definition.

The VCCodeFunction object provides code model functionality to existing Visual C++ IDE solutions at the function level. Primarily, this object is used to access or modify an existing function construct.

System_CAPS_noteNote

A large part of the functionality of this object is provided by the Visual Studio CodeFunction object. For more information, see CodeFunction object.

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 all functions in the solution and displays the name of each.

Sub GetFunctions()
    Dim vcCM as VCCodeModel
    Dim vcFunc as VCCodeFunction
    vcCM = DTE.Solution.Item(1).CodeModel
    For Each vcFunc in vcCM.Functions
        MsgBox(vcFunc.DisplayName)
End Sub
Return to top
Show: