IVsXMLMemberData.GetSummaryText Method

Gets summary text describing a member.

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

Syntax

'Declaration
Function GetSummaryText ( _
    <OutAttribute> ByRef pbstrSummary As String _
) As Integer
int GetSummaryText(
    out string pbstrSummary
)
int GetSummaryText(
    [OutAttribute] String^% pbstrSummary
)
abstract GetSummaryText : 
        pbstrSummary:string byref -> int 
function GetSummaryText(
    pbstrSummary : String
) : int

Parameters

  • pbstrSummary
    Type: System.String%
    [in] Summary text of describing a member.

Return Value

Type: System.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
);

.NET Framework Security

See Also

Reference

IVsXMLMemberData Interface

Microsoft.VisualStudio.Shell.Interop Namespace