IVsPersistSolutionProps.ReadSolutionProps Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Reads out solution properties from its .sln file.

public:
 int ReadSolutionProps(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierarchy, System::String ^ pszProjectName, System::String ^ pszProjectMk, System::String ^ pszKey, int fPreLoad, Microsoft::VisualStudio::OLE::Interop::IPropertyBag ^ pPropBag);

public:
 int ReadSolutionProps(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierarchy, Platform::String ^ pszProjectName, Platform::String ^ pszProjectMk, Platform::String ^ pszKey, int fPreLoad, Microsoft::VisualStudio::OLE::Interop::IPropertyBag ^ pPropBag);

int ReadSolutionProps(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & pHierarchy, std::wstring const & pszProjectName, std::wstring const & pszProjectMk, std::wstring const & pszKey, int fPreLoad, Microsoft::VisualStudio::OLE::Interop::IPropertyBag const & pPropBag);

public int ReadSolutionProps (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHierarchy, string pszProjectName, string pszProjectMk, string pszKey, int fPreLoad, Microsoft.VisualStudio.OLE.Interop.IPropertyBag pPropBag);

abstract member ReadSolutionProps : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * string * string * string * int * Microsoft.VisualStudio.OLE.Interop.IPropertyBag -> int

Public Function ReadSolutionProps (pHierarchy As IVsHierarchy, pszProjectName As String, pszProjectMk As String, pszKey As String, fPreLoad As Integer, pPropBag As IPropertyBag) As Integer

Parameters

pHierarchy

IVsHierarchy

[in] Pointer to the IVsHierarchy interface. null for preSolution or global sections because the hierarchy does not exist if the solution has yet to create it, or because the section being loaded is global.

pszProjectName

String

[in] null for global sections, which means a load for the global section of the solution (.sln) file.

pszProjectMk

String

[in] null for global sections, which means a load for the global section of the solution (.sln) file.

pszKey

String

[in] Name of the solution's property set, that is, its property bag.

fPreLoad

Int32

[in] Indicator of whether a ReadSolutionProps(IVsHierarchy, String, String, String, Int32, IPropertyBag) call is from a pre- or post-load section.

pPropBag

IPropertyBag

[in] Pointer to the IPropertyBag interface.

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 IVsPersistSolutionProps::ReadSolutionProps(  
   [in] IVsHierarchy *pHierarchy,  
   [in] LPCOLESTR pszProjectName,  
   [in] LPCOLESTR pszProjectMk,  
   [in] LPCOLESTR pszKey,  
   [in] BOOL fPreLoad,  
   [in] IPropertyBag *pPropBag  
);  

Called by the environment when loading the solution file so it can use the registry to map the pszKey to a particular VSPackage.