IVsXMLMemberData.GetSummaryText(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Gets summary text describing a member.

public:
 int GetSummaryText([Runtime::InteropServices::Out] System::String ^ % pbstrSummary);

int GetSummaryText([Runtime::InteropServices::Out] std::wstring const & & pbstrSummary);

public int GetSummaryText (out string pbstrSummary);

abstract member GetSummaryText : string -> int

Public Function GetSummaryText (ByRef pbstrSummary As String) As Integer

Parameters

pbstrSummary: String

[in] Summary text of describing a member.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsXMLMemberData::GetSummaryText(  
   [out] BSTR *pbstrSummary  
);

Applies to

Share via