ColorableItem.GetDescription Method
Returns a description for this colorable 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)
Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
Syntax
'Declaration
Public Overridable Function GetDescription ( _
<OutAttribute> ByRef desc As String _
) As Integer
public virtual int GetDescription(
out string desc
)
public:
virtual int GetDescription(
[OutAttribute] String^% desc
)
abstract GetDescription :
desc:string byref -> int
override GetDescription :
desc:string byref -> int
public function GetDescription(
desc : String
) : int
Parameters
desc
Type: String%[out] A string containing a description.
Return Value
Type: Int32
If successful, returns S_OK; otherwise, returns an error code.
Implements
IVsMergeableUIItem.GetDescription(String%)
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.
.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.