IVsUIElementPane.SaveUIElementState(IStream) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Stores the state of the pane.

public:
 int SaveUIElementState(Microsoft::VisualStudio::OLE::Interop::IStream ^ pstream);

public:
 int SaveUIElementState(Microsoft::VisualStudio::OLE::Interop::IStream ^ pstream);

int SaveUIElementState(Microsoft::VisualStudio::OLE::Interop::IStream const & pstream);

public int SaveUIElementState (Microsoft.VisualStudio.OLE.Interop.IStream pstream);

abstract member SaveUIElementState : Microsoft.VisualStudio.OLE.Interop.IStream -> int

Public Function SaveUIElementState (pstream As IStream) As Integer

Parameters

pstream: IStream

The stream to which to save the state.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Implement this method to save any custom state that must be persisted across sessions. This may include the selected items, caret position, data connections, and other aspects of the pane

Applies to