Partager via


ColorableItem.GetDescription(String) Method

Definition

Returns a description for this colorable item.

public:
 virtual int GetDescription([Runtime::InteropServices::Out] System::String ^ % desc);
 virtual int GetDescription([Runtime::InteropServices::Out] std::wstring const & & desc);
public virtual int GetDescription (out string desc);
abstract member GetDescription : string -> int
override this.GetDescription : string -> int
Public Overridable Function GetDescription (ByRef desc As String) As Integer

Parameters

desc
String

[out] A string containing a description.

Returns

If successful, returns S_OK; otherwise, returns an error code.

Implements

Remarks

This method is an implementation of the GetDescription method in the IVsMergeableUIItem interface.

The base method returns a null value for the description (the core text editor does not use this value) and a success code of E_NOTIMPL.

Applies to