Share via


Declarations.GetDescription(Int32) Method

Definition

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

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] The index of the item for which to get the description.

Returns

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

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".

Applies to