CodeParameter2 Interface

  • Article

An object defining a parameter to a function, property, and so on.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
<GuidAttribute("35CD9E36-7C96-4429-968F-C0C350CB1A47")> _
Public Interface CodeParameter2 _
    Inherits CodeParameter

[GuidAttribute("35CD9E36-7C96-4429-968F-C0C350CB1A47")]
public interface CodeParameter2 : CodeParameter

[GuidAttribute(L"35CD9E36-7C96-4429-968F-C0C350CB1A47")]
public interface class CodeParameter2 : CodeParameter

[<GuidAttribute("35CD9E36-7C96-4429-968F-C0C350CB1A47")>]
type CodeParameter2 =  
    interface
        interface CodeParameter
    end

public interface CodeParameter2 extends CodeParameter

The CodeParameter2 type exposes the following members.

Properties

  Name Description
Public property Attributes Gets a collection of the attributes for the parent object.
Public property Children Gets a collection of objects contained within this code construct.
Public property Collection Gets the collection containing the CodeParameter object supporting this property.
Public property DefaultValue Gets or sets the literal value that exists in the code.
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 Extender Gets the requested Extender if it is available for the CodeParameter object.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the CodeParameter object.
Public property ExtenderNames Gets a list of available Extenders for the object.
Public property FullName Gets the full path and name of the object's file.
Public property InfoLocation Gets the capabilities of the code model.
Public property IsCodeType Gets a value indicating whether a CodeType object can be obtained from this CodeParameter object.
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 Name Gets or sets the name of the object.
Public property ParameterKind Gets or sets a value indicating whether the parameter is expected to have value or reference behavior
Public property Parent Gets the immediate parent object of a CodeParameter object.
Public property ProjectItem Gets the ProjectItem associated with the given object.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.
Public property Type Gets or sets an object representing the programmatic 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.

Top

Remarks

The CodeParameter object represents formal parameters of a function definition.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

See Also

Reference

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)