IVsPropertyStreamOut.BeginPropertySection Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

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

public:
 int BeginPropertySection(System::String ^ szName, System::String ^ szLineComment, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyStreamOut ^ % ppIVsPropertyStreamOut, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int BeginPropertySection(std::wstring const & szName, std::wstring const & szLineComment, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPropertyStreamOut const & & ppIVsPropertyStreamOut, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int BeginPropertySection (string szName, string szLineComment, out Microsoft.VisualStudio.Shell.Interop.IVsPropertyStreamOut ppIVsPropertyStreamOut, out uint pdwCookie);

abstract member BeginPropertySection : string * string * IVsPropertyStreamOut * uint32 -> int

Public Function BeginPropertySection (szName As String, szLineComment As String, ByRef ppIVsPropertyStreamOut As IVsPropertyStreamOut, ByRef pdwCookie As UInteger) As Integer

Parameters

szName: String

[in] String containing the name of the property section.

szLineComment: String

[in] String containing a comment about the section.

ppIVsPropertyStreamOut: IVsPropertyStreamOut

[out] Pointer to the BeginPropertySection(String, String, IVsPropertyStreamOut, UInt32) interface to use for output.

pdwCookie: UInt32

[out] Pointer to an integer that is a cookie identifying this property section. Used in the call to EndPropertySection(UInt32).

Returns

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  
);

Applies to