IVsPersistSolutionProps.WriteUserOptions(IStream, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Writes user options for a given solution.

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

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

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

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

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

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

Parameters

pOptionsStream

IStream

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

pszKey

String

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

Returns

Int32

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

Implements

WriteUserOptions(IStream, String)

Remarks

COM Signature

From vsshell.idl:

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

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