Declarations.GetDescription Method
When implemented in a derived class, gets a description of the specified item.
Namespace: Microsoft.VisualStudio.Package
Assemblies: Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
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)
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] The index of the item for which to get the description.
Return Value
Type: System.String
If successful, returns the description; otherwise, returns nulla null reference (Nothing in Visual Basic).
Remarks
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".
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.