IVsPersistSolutionOpts::ReadUserOptions Method (IStream^, String^)

Visual Studio 2015

Reads user options for a given solution.

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

Syntax

int ReadUserOptions(
	IStream^ pOptionsStream,
	String^ pszKey
)

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

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

Type: System::Int32

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

From vsshell.idl:

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

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