IVsObjectBrowserDescription3::ClearDescriptionText Method ()

Visual Studio 2015
 

Clears the Object Browser description text.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

C#
C++
F#
VB
Copy 
int ClearDescriptionText()

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

From vsshell80.idl:

C++
Copy 
HRESULT IVsObjectBrowserDescription3::ClearDescriptionText();

The environment passes a pointer to the IVsObjectBrowserDescription3 interface when it calls FillDescription on an item that the user has selected in the Object Browser. Call the ClearDescriptionText method to clear the IVsObjectBrowserDescription3 stream and reset it. You need to do this only if you have already written something to the IVsObjectBrowserDescription3 stream through AddDescriptionText3.

Return to top
Show: