Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Returns a document outline caption.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function GetOutlineCaption ( _
nCaptionType As VSOUTLINECAPTION, _
<OutAttribute> ByRef pbstrCaption As String _
) As Integer
int GetOutlineCaption(
VSOUTLINECAPTION nCaptionType,
out string pbstrCaption
)
int GetOutlineCaption(
[InAttribute] VSOUTLINECAPTION nCaptionType,
[OutAttribute] String^% pbstrCaption
)
abstract GetOutlineCaption :
nCaptionType:VSOUTLINECAPTION *
pbstrCaption:string byref -> int
function GetOutlineCaption(
nCaptionType : VSOUTLINECAPTION,
pbstrCaption : String
) : int
Parameters
- nCaptionType
Type: Microsoft.VisualStudio.Shell.Interop.VSOUTLINECAPTION
[in] Caption type. Value is taken from the VSOUTLINECAPTION enumeration.
- pbstrCaption
Type: System.String%
[out] Pointer to a BSTR that contains the document outline caption.
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 IVsDocOutlineProvider::GetOutlineCaption(
[in] VSOUTLINECAPTION nCaptionType,
[out] BSTR* pbstrCaption
);
.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.