IVsSimpleLibrary2.SaveState Method

Article
02/04/2013

Asks the library to save its persisted global Browse Containers.

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

Syntax

'Declaration
Function SaveState ( _
    pIStream As IStream, _
    lptType As LIB_PERSISTTYPE _
) As Integer

int SaveState(
    IStream pIStream,
    LIB_PERSISTTYPE lptType
)

int SaveState(
    [InAttribute] IStream^ pIStream, 
    [InAttribute] LIB_PERSISTTYPE lptType
)

abstract SaveState : 
        pIStream:IStream * 
        lptType:LIB_PERSISTTYPE -> int

function SaveState(
    pIStream : IStream, 
    lptType : LIB_PERSISTTYPE
) : int

Parameters

pIStream
Type: Microsoft.VisualStudio.OLE.Interop.IStream
[in] An IStream object to write to.

lptType
Type: Microsoft.VisualStudio.Shell.Interop.LIB_PERSISTTYPE
[in] Specifies the persisted type of the library. Always LPT_GLOBAL from the LIB_PERSISTTYPE enumeration.

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

HRESULT IVsSimpleLibrary2::SaveState(
   [in] IStream         *pIStream, 
   [in] LIB_PERSISTTYPE  lptType
);

The environment calls this method to indicate that browse container information should be persisted. This method is meaningful only for libraries providing global browse containers. As such, the lptType parameter is always LPT_GLOBAL. Fill the IStream object given in the pIStream parameter with whatever library information you choose to persist.

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