IVsWindowPane.SaveViewState Method

Article
04/22/2008

Saves a view state of a document window.

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

Syntax

'Déclaration
Function SaveViewState ( _
    pStream As IStream _
) As Integer
'Utilisation
Dim instance As IVsWindowPane
Dim pStream As IStream
Dim returnValue As Integer

returnValue = instance.SaveViewState(pStream)

int SaveViewState(
    IStream pStream
)

int SaveViewState(
    [InAttribute] IStream^ pStream
)

function SaveViewState(
    pStream : IStream
) : int

Parameters

pStream
Type: Microsoft.VisualStudio.OLE.Interop.IStream

[in] Pointer to the IStream interface of the view state to save.

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 IVsWindowPane::SaveViewState(
   [in] IStream *pstream
);

SaveViewState is called when the window pane in question is associated with a document view object. SaveViewState is not called for tool windows. If you want to implement persistence for your tool windows, you have to provide the implementation yourself. The Visual Studio environment only persists the tool window layout.

Permissions

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.

Partager via