IVsSolutionPersistence.LoadPackageUserOpts Method

Article
10/26/2012

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.

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

Syntax

'Declaration
Function LoadPackageUserOpts ( _
    pPSO As IVsPersistSolutionOpts, _
    pszKey As String _
) As Integer

'Usage
Dim instance As IVsSolutionPersistence 
Dim pPSO As IVsPersistSolutionOpts 
Dim pszKey As String 
Dim returnValue As Integer 

returnValue = instance.LoadPackageUserOpts(pPSO, _
    pszKey)

int LoadPackageUserOpts(
    IVsPersistSolutionOpts pPSO,
    string pszKey
)

int LoadPackageUserOpts(
    [InAttribute] IVsPersistSolutionOpts^ pPSO, 
    [InAttribute] String^ pszKey
)

function LoadPackageUserOpts(
    pPSO : IVsPersistSolutionOpts, 
    pszKey : String
) : int

Parameters

pPSO
Type: Microsoft.VisualStudio.Shell.Interop.IVsPersistSolutionOpts

[in] Pointer to the IVsPersistSolutionOpts interface.

pszKey
Type: System.String

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

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::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.

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