IVsUIShell2.IsAutoRecoverSavingCheckpoints Method

Article
2013-03-06

Indicates whether unsaved documents are currently being auto-saved.

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

Syntax

'Declaration
Function IsAutoRecoverSavingCheckpoints ( _
    <OutAttribute> ByRef pfARSaving As Integer _
) As Integer

int IsAutoRecoverSavingCheckpoints(
    out int pfARSaving
)

int IsAutoRecoverSavingCheckpoints(
    [OutAttribute] int% pfARSaving
)

abstract IsAutoRecoverSavingCheckpoints : 
        pfARSaving:int byref -> int

function IsAutoRecoverSavingCheckpoints(
    pfARSaving : int
) : int

Parameters

pfARSaving
Type: System.Int32%
[out] Returns nonzero (TRUE) if Visual Studio is in the process of auto-saving all open documents that need to be saved; otherwise, returns zero (FALSE).

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 IVsUIShell2::IsAutoRecoverSavingCheckpoints(
   [out] BOOL *pfARSaving
);

When AutoRecover is enabled, all unsaved documents are automatically saved after a period of time (specified by the user in the Options dialog box available from the Tools menu). For the duration of saving all unsaved documents, a flag is set. The IsAutoRecoverSavingCheckpoints method returns the value of this flag.

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

Share via