IVsObjectBrowserDescription3.ClearDescriptionText Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Clears the Object Browser description text.

public:
 int ClearDescriptionText();

public:
 int ClearDescriptionText();

int ClearDescriptionText();

public int ClearDescriptionText ();

abstract member ClearDescriptionText : unit -> int

Public Function ClearDescriptionText () As Integer

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

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.

Applies to

Partilhar via