Share via


Methods.GetDescription Method

When implemented in a derived class, gets the description of the specified method signature.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public MustOverride Function GetDescription ( _
    index As Integer _
) As String
public abstract string GetDescription(
    int index
)
public:
virtual String^ GetDescription(
    int index
) abstract
abstract GetDescription : 
        index:int -> string
public abstract function GetDescription(
    index : int
) : String

Parameters

  • index
    Type: System.Int32

    [in] An index into the internal list to the desired method signature.

Return Value

Type: System.String
The description of the specified method signature, or nulla null reference (Nothing in Visual Basic) if the method signature does not exist.

Remarks

The description could be obtained from a comment that appears before the method in the source, or it could simply be an empty string.

.NET Framework Security

See Also

Reference

Methods Class

Microsoft.VisualStudio.Package Namespace