Lire en anglais

Partager via


VCCodeParameter Interface

An object representing a parameter of a function, property, and so on, in a source file.

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

Syntax

'Déclaration
<GuidAttribute("EDA77486-28EC-4BD9-A73C-161B355203BB")> _
Public Interface VCCodeParameter
[GuidAttribute("EDA77486-28EC-4BD9-A73C-161B355203BB")]
public interface VCCodeParameter
[GuidAttribute(L"EDA77486-28EC-4BD9-A73C-161B355203BB")]
public interface class VCCodeParameter
[<GuidAttribute("EDA77486-28EC-4BD9-A73C-161B355203BB")>]
type VCCodeParameter =  interface end
public interface VCCodeParameter

The VCCodeParameter type exposes the following members.

Properties

  Name Description
Public property Attributes Gets a collection of all of the attributes for the parent 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 DefaultExpression Gets or sets an object defining the initialization code for an element.
Public property DisplayName Gets the name used in the user interface for this output group.
Public property DocComment Gets or sets the document comment for the current code model element.
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 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 Index Gets the position of a parameter in a parameter list.
Public property InfoLocation Describes the capabilities of the code model.
Public property IsCaseSensitive Determines if 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 IsConstant Gets or sets a value to describe whether this item is a constant.
Public property IsInjected Gets if a code element has been injected by an attribute or macro expansion.
Public property IsReadOnly Gets a value that indicates whether the file containing the object is read-only.
Public property IsVolatile Gets or sets a value indicating whether the volatile keyword is used.
Public property IsZombie Determines if the object 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 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 Returns a TextPoint object that defines the beginning of the code item.
Public property StartPointOf Gets the start point of the object.
Public property Type Gets or sets an object representing the programmatic type.
Public property TypeString Gets or sets the type of the object using a string representation of the type.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute 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 the code element.

Top

Remarks

The VCCodeParameter object represents the formal parameters of a function definition in a source file, allowing access to the properties of the parameter list.

Notes

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

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 all parameters in the first global function of a solution and displays the name of each.

Sub GetFunctionParams()
    Dim vcCM as VCCodeModel
    Dim vcFunc as VCCodeFunction
    Dim vcParam as VCCodeParameter
    vcCM = DTE.Solution.Item(1).CodeModel
    vcFunc = vcCM.Functions.Item(1)
    For Each vcParam in vcFunc.Parameters
        MsgBox(vcParam.DisplayName)
    Next
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace