IVsPersistSolutionProps.WriteUserOptions Method (IStream, String)

Writes user options for a given solution.

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

Syntax

'Declaration
Function WriteUserOptions ( _
    pOptionsStream As IStream, _
    pszKey As String _
) As Integer
'Usage
Dim instance As IVsPersistSolutionProps
Dim pOptionsStream As IStream
Dim pszKey As String
Dim returnValue As Integer

returnValue = instance.WriteUserOptions(pOptionsStream, _
    pszKey)

int WriteUserOptions(
    IStream pOptionsStream,
    string pszKey
)

int WriteUserOptions(
    [InAttribute] IStream^ pOptionsStream, 
    [InAttribute] String^ pszKey
)

abstract WriteUserOptions : 
        pOptionsStream:IStream * 
        pszKey:string -> int

function WriteUserOptions(
    pOptionsStream : IStream, 
    pszKey : String
) : int

Parameters

pOptionsStream
Type: Microsoft.VisualStudio.OLE.Interop.IStream
[in] Pointer to the IStream interface to which the VSPackage should write the user-specific options.

pszKey
Type: System.String
[in] Name of the stream, as provided by the VSPackage by means of the SavePackageUserOpts

Return Value

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

Implements

IVsPersistSolutionOpts.WriteUserOptions(IStream, String)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPersistSolutionProps::WriteUserOptions(
   [in] IStream *pOptionsStream,
   [in] LPCOLESTR pszKey
);

This method is invoked by the environment each time a VSPackage invokes the method SavePackageUserOpts.

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