IVsPersistSolutionOpts2.LoadUserOptionsEx Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Loads user options for a given solution.

public:
 void LoadUserOptionsEx(int fPreLoad, Microsoft::VisualStudio::Shell::Interop::IVsSolutionPersistence ^ pPersistence, System::UInt32 grfLoadOpts);
public:
 void LoadUserOptionsEx(int fPreLoad, Microsoft::VisualStudio::Shell::Interop::IVsSolutionPersistence ^ pPersistence, unsigned int grfLoadOpts);
void LoadUserOptionsEx(int fPreLoad, Microsoft::VisualStudio::Shell::Interop::IVsSolutionPersistence const & pPersistence, unsigned int grfLoadOpts);
public void LoadUserOptionsEx (int fPreLoad, Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence pPersistence, uint grfLoadOpts);
abstract member LoadUserOptionsEx : int * Microsoft.VisualStudio.Shell.Interop.IVsSolutionPersistence * uint32 -> unit
Public Sub LoadUserOptionsEx (fPreLoad As Integer, pPersistence As IVsSolutionPersistence, grfLoadOpts As UInteger)

Parameters

fPreLoad
Int32

[in] Inidicates if any user options are to be preloaded. If true, the user options are preloaded.

pPersistence
IVsSolutionPersistence

[in] Pointer to the IVsSolutionPersistence interface on which the VSPackage should call its LoadPackageUserOpts(IVsPersistSolutionOpts, String) method for each stream name it wants to read from the user options (.opt) file.

grfLoadOpts
UInt32

[in] User options whose value is taken from the __VSLOADUSEROPTS DWORD.

Remarks

If your package implements IVsPersistSolutionOpts2, this method is called in preference to LoadUserOptions when opening the solution, after all synchronously loaded projects are opened, with fPreLoad=false. In addition, this method is also called for the same Solution User Options (SUO) immediately before any synchronous loaded projects are opened, with fPreLoad=true. This allows the package to preload any user options that may be queried by project factories while opening projects. LoadUserOptions(pPersistence, grfLoadOpts) behaves the same as LoadUserOptionsEx(FALSE, pPersistence, grfLoadOpts).

Applies to