IVsPropertyStreamOut.BeginPropertySection Method

Article
03/06/2013

Begins a property section (inner property stream) used until a call to EndPropertySection.

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

Syntax

'Declaration
Function BeginPropertySection ( _
    szName As String, _
    szLineComment As String, _
    <OutAttribute> ByRef ppIVsPropertyStreamOut As IVsPropertyStreamOut, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

int BeginPropertySection(
    string szName,
    string szLineComment,
    out IVsPropertyStreamOut ppIVsPropertyStreamOut,
    out uint pdwCookie
)

int BeginPropertySection(
    [InAttribute] String^ szName, 
    [InAttribute] String^ szLineComment, 
    [OutAttribute] IVsPropertyStreamOut^% ppIVsPropertyStreamOut, 
    [OutAttribute] unsigned int% pdwCookie
)

abstract BeginPropertySection : 
        szName:string * 
        szLineComment:string * 
        ppIVsPropertyStreamOut:IVsPropertyStreamOut byref * 
        pdwCookie:uint32 byref -> int

function BeginPropertySection(
    szName : String, 
    szLineComment : String, 
    ppIVsPropertyStreamOut : IVsPropertyStreamOut, 
    pdwCookie : uint
) : int

Parameters

szName
Type: System.String
[in] String containing the name of the property section.

szLineComment
Type: System.String
[in] String containing a comment about the section.

ppIVsPropertyStreamOut
Type: Microsoft.VisualStudio.Shell.Interop.IVsPropertyStreamOut%
[out] Pointer to the BeginPropertySection interface to use for output.

pdwCookie
Type: System.UInt32%
[out] Pointer to an integer that is a cookie identifying this property section. Used in the call to EndPropertySection.

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:

[C++]

HRESULT IVsPropertyStreamOut::BeginPropertySection(
   [in] LPCOLESTR szName, 
   [in] LPCOLESTR szLineComment, 
   [out] IVsPropertyStreamOut **ppIVsPropertyStreamOut, 
   [out] VSCOOKIE *pdwCookie
);

.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.

Share via