Partager via


IVsPersistSolutionProps.ReadUserOptions Method

Reads 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 ReadUserOptions ( _
    pOptionsStream As IStream, _
    pszKey As String _
) As Integer
int ReadUserOptions(
    IStream pOptionsStream,
    string pszKey
)
int ReadUserOptions(
    [InAttribute] IStream^ pOptionsStream, 
    [InAttribute] String^ pszKey
)
abstract ReadUserOptions : 
        pOptionsStream:IStream * 
        pszKey:string -> int
function ReadUserOptions(
    pOptionsStream : IStream, 
    pszKey : String
) : int

Parameters

  • pszKey
    Type: String

    [in] Name of the stream, as provided by the VSPackage by means of the method LoadPackageUserOpts

Return Value

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

Remarks

COM Signature

From vsshell.idl:

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

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

.NET Framework Security

See Also

Reference

IVsPersistSolutionProps Interface

Microsoft.VisualStudio.Shell.Interop Namespace