Share via


IVsPersistSolutionProps.ReadUserOptions(IStream, String) Method

Definition

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

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

Implements

Remarks

Implementors of this method are expected to be safe to be accesssed from any thread if its owner is passed to IVsSolutionPersistence on a background thread.

Applies to