IVsPropertyStreamOut.Write(String, Object, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Writes a property name, value, and comment to the stream.

int Write(std::wstring const & szPropertyName, winrt::Windows::Foundation::IInspectable const & varValue, std::wstring const & szLineComment);

public int Write (string szPropertyName, object varValue, string szLineComment);

abstract member Write : string * obj * string -> int

Public Function Write (szPropertyName As String, varValue As Object, Optional szLineComment As String) As Integer

Parameters

szPropertyName: String

[in] String containing the name of the property.

varValue: Object

[in] A VARIANT containing the property value.

szLineComment: String

[in] An optional string containing a comment.

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::Write(  
   [in] LPCOLESTR szPropertyName,   
   [in] VARIANT varValue,   
   [in, optional] LPCOLESTR szLineComment  
);

Applies to

Share via