Share via


CloseFileRestoreContext function

Closes the context that is used to restore files. If the file system volume is exclusively locked, this function removes the lock.

Note

FMAPI can only be used in the Windows Preinstallation Environment (WinPE) for Windows Vista, Windows Server 2008, and later. Applications that use FMAPI must license WinPE.

Syntax

BOOL WINAPI CloseFileRestoreContext(
  _In_ PFILE_RESTORE_CONTEXT Context
);

Parameters

Context [in]

A pointer to the file restore context created by the CreateFileRestoreContext function.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

This function has no associated header file or import library. You must use the LoadLibrary and GetProcAddress functions to dynamically link to fmapi.dll.

This function cancels an ongoing restoration process that was initiated with the RestoreFile function.

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
DLL
Fmapi.dll

See also

RestoreFile