IVsLibrary2::LoadState Method (IStream^, LIB_PERSISTTYPE)

Visual Studio 2015

Asks the library to load 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

C++

int LoadState(
	IStream^ pIStream,
	LIB_PERSISTTYPE lptType
)

Parameters

pIStream: Type: Microsoft.VisualStudio.OLE.Interop::IStream^
[in] Pointer to an IStream interface.

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

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:

C++

HRESULT IVsLibrary2::LoadState(
   [in] IStream *pIStream, 
   [in] LIB_PERSISTTYPE lptType
);

When a library manager registers itself with the environment's object manager, the environment iteratively calls this method for each library within the library manager to load its list of persisted containers. Because this method is meaningful only for libraries providing global browse containers, the lptType parameter is always LPT_GLOBAL. The pIStream parameter specifies an IStream object from which to get the persisted containers.