IVsPreviewChangesEngine.GetDescription Method

Gets the dialog description text.

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

Syntax

'Declaration
Function GetDescription ( _
    <OutAttribute> ByRef pbstrDescription As String _
) As Integer
'Usage
Dim instance As IVsPreviewChangesEngine
Dim pbstrDescription As String
Dim returnValue As Integer

returnValue = instance.GetDescription(pbstrDescription)

int GetDescription(
    out string pbstrDescription
)

int GetDescription(
    [OutAttribute] String^% pbstrDescription
)

abstract GetDescription : 
        pbstrDescription:string byref -> int

function GetDescription(
    pbstrDescription : String
) : int

Parameters

pbstrDescription
Type: System.String%
[out]

Return Value

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.