Methods.GetDescription(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 abstract System::String ^ GetDescription(int index);

public:
 abstract Platform::String ^ GetDescription(int index);

 abstract std::wstring GetDescription(int index);

public abstract string GetDescription (int index);

abstract member GetDescription : int -> string

Public MustOverride Function GetDescription (index As Integer) As String

Parameters

index: Int32

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

Returns

String

The description of the specified method signature, or null 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.

Applies to