IVsPropertyFileOut.WriteSzAsBSTR Method

Article
02/04/2013

Write out a null-terminated string property value as a BSTR.

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

Syntax

'Declaration
Function WriteSzAsBSTR ( _
    szPropertyName As String, _
    szValue As String, _
    szLineComment As String _
) As Integer

int WriteSzAsBSTR(
    string szPropertyName,
    string szValue,
    string szLineComment
)

int WriteSzAsBSTR(
    [InAttribute] String^ szPropertyName, 
    [InAttribute] String^ szValue, 
    [InAttribute] String^ szLineComment
)

abstract WriteSzAsBSTR : 
        szPropertyName:string * 
        szValue:string * 
        szLineComment:string -> int

function WriteSzAsBSTR(
    szPropertyName : String, 
    szValue : String, 
    szLineComment : String
) : int

Parameters

szPropertyName
Type: System.String
[in] String containing the property name.

szValue
Type: System.String
[in] String containing the property's value.

szLineComment
Type: System.String
[in] An optional string containing a comment.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsPropertyStreamOut.WriteSzAsBSTR(String, String, String)

Remarks

COM Signature

From vsshell.idl:

[C++]++++-

HRESULT IVsPropertyFileOut::WriteSzAsBSTR(
   [in] LPCOLESTR szPropertyName, 
   [in] LPCOLESTR szValue, 
   [in, optional] LPCOLESTR szLineComment
);

.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