IVsPersistSolutionOpts.WriteUserOptions Method

Article
04/22/2008

Writes user options for a given solution.

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

Syntax

'Déclaration
Function WriteUserOptions ( _
    pOptionsStream As IStream, _
    pszKey As String _
) As Integer
'Utilisation
Dim instance As IVsPersistSolutionOpts
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
)

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

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:

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

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

Permissions

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.

Partager via