IVsSolutionPersistence.LoadPackageUserOpts 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.

Enables the loading of package-level user options that are stored in one or more named streams in the solution .sln file. This method allows the caller to name the option stream (or streams) to be loaded.

public:
 int LoadPackageUserOpts(Microsoft::VisualStudio::Shell::Interop::IVsPersistSolutionOpts ^ pPSO, System::String ^ pszKey);

public:
 int LoadPackageUserOpts(Microsoft::VisualStudio::Shell::Interop::IVsPersistSolutionOpts ^ pPSO, Platform::String ^ pszKey);

int LoadPackageUserOpts(Microsoft::VisualStudio::Shell::Interop::IVsPersistSolutionOpts const & pPSO, std::wstring const & pszKey);

public int LoadPackageUserOpts (Microsoft.VisualStudio.Shell.Interop.IVsPersistSolutionOpts pPSO, string pszKey);

abstract member LoadPackageUserOpts : Microsoft.VisualStudio.Shell.Interop.IVsPersistSolutionOpts * string -> int

Public Function LoadPackageUserOpts (pPSO As IVsPersistSolutionOpts, pszKey As String) As Integer

Parameters

pPSO: IVsPersistSolutionOpts

[in] Pointer to the IVsPersistSolutionOpts interface.

pszKey: String

[in] Name of the stream to be opened in the options file storage.

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 IVsSolutionPersistence::LoadPackageUserOpts(  
   [in] IVsPersistSolutionOpts *pPSO,  
   [in] LPCOLESTR pszKey  
);

The method provides an intermediary function for IVsPersistSolutionOpts to call to obtain stream names it needs to implement its ReadUserOptions method.

Applies to