IVsSolutionPersistence.SavePackageSolutionProps Method

Article
07/12/2014

Writes properties to the solution .sln file.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function SavePackageSolutionProps ( _
    fPreLoad As Integer, _
    pHierarchy As IVsHierarchy, _
    ppSP As IVsPersistSolutionProps, _
    pszKey As String _
) As Integer

int SavePackageSolutionProps(
    int fPreLoad,
    IVsHierarchy pHierarchy,
    IVsPersistSolutionProps ppSP,
    string pszKey
)

int SavePackageSolutionProps(
    [InAttribute] int fPreLoad, 
    [InAttribute] IVsHierarchy^ pHierarchy, 
    [InAttribute] IVsPersistSolutionProps^ ppSP, 
    [InAttribute] String^ pszKey
)

abstract SavePackageSolutionProps : 
        fPreLoad:int * 
        pHierarchy:IVsHierarchy * 
        ppSP:IVsPersistSolutionProps * 
        pszKey:string -> int

function SavePackageSolutionProps(
    fPreLoad : int, 
    pHierarchy : IVsHierarchy, 
    ppSP : IVsPersistSolutionProps, 
    pszKey : String
) : int

Parameters

fPreLoad
Type: System.Int32

[in] true if the solution properties are to be pre-loaded.

pHierarchy
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy

[in] Pointer to the IVsHierarchy interface. A nulla null reference (Nothing in Visual Basic) value indicates the global section of the solution file is to be saved.

ppSP
Type: Microsoft.VisualStudio.Shell.Interop.IVsPersistSolutionProps

[in] Pointer to the IVsPersistSolutionProps interface.

pszKey
Type: System.String

[in] Name of the solution file section (the property bag) for which the properties should be written.

Return Value

Type: System.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::SavePackageSolutionProps(
   [in] BOOL fPreLoad,
   [in] IVsHierarchy *pHierarchy,
   [in] IVsPersistSolutionProps *pPSP,
   [in] LPCOLESTR pszKey
);

Use this method to obtain the property bag name to be used with WriteSolutionProps

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via