IVsPersistSolutionOpts.ReadUserOptions(IStream, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Reads user options for a given solution.

public:
 int ReadUserOptions(Microsoft::VisualStudio::OLE::Interop::IStream ^ pOptionsStream, System::String ^ pszKey);

public:
 int ReadUserOptions(Microsoft::VisualStudio::OLE::Interop::IStream ^ pOptionsStream, Platform::String ^ pszKey);

int ReadUserOptions(Microsoft::VisualStudio::OLE::Interop::IStream const & pOptionsStream, std::wstring const & pszKey);

public int ReadUserOptions (Microsoft.VisualStudio.OLE.Interop.IStream pOptionsStream, string pszKey);

abstract member ReadUserOptions : Microsoft.VisualStudio.OLE.Interop.IStream * string -> int

Public Function ReadUserOptions (pOptionsStream As IStream, pszKey As String) As Integer

Parameters

pOptionsStream: IStream

[in] Pointer to the IStream interface from which the VSPackage should read the user-specific options.

pszKey: String

[in] Name of the stream, as provided by the VSPackage by means of the method LoadPackageUserOpts(IVsPersistSolutionOpts, String).

Returns

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::ReadUserOptions(  
   [in] IStream *pOptionsStream,  
   [in] LPCOLESTR pszKey  
);

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

Applies to