IVsPreviewChangesEngine.GetDescription(String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the dialog description text.

public:
 int GetDescription([Runtime::InteropServices::Out] System::String ^ % pbstrDescription);

int GetDescription([Runtime::InteropServices::Out] std::wstring const & & pbstrDescription);

public int GetDescription (out string pbstrDescription);

abstract member GetDescription : string -> int

Public Function GetDescription (ByRef pbstrDescription As String) As Integer

Parameters

pbstrDescription

String

[out] The text of the dialog description.

Returns

Int32

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

Remarks

This applies to tree view description text.

COM Signature

From vsshell80.idl:

HRESULT GetDescription([out] BSTR *pbstrDescription);