Declarations::GetDescription Method (Int32)

Visual Studio 2015
 

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

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

C#
C++
F#
VB
Copy 
public:
virtual String^ GetDescription(
	int index
) abstract

Parameters

index
Type: System::Int32

[in] The index of the item for which to get the description.

Return Value

Type: System::String^

If successful, returns the description; otherwise, returns null.

If an item does not contain a description, an empty string can be returned. A description can be obtained from the source during the parsing operation, typically from a comment before or after the parsed item. Sometimes the description can simply be the type of the declaration; for example, an integer variable could have a description of simply "integer" or "int".

Return to top
Show: