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