Share via


EwfMgrCheckpoint (Standard 8)

7/8/2014

Review the use, syntax, parameters, and return values of the EwfMgrCheckpoint function of the EWF API in Windows Embedded 8 Standard (Standard 8).

This function adds a checkpoint overlay level on the specified Enhanced Write Filter (EWF)-protected volume.

Syntax

BOOL EwfMgrCheckpoint(
  HANDLE hDevice,
  OPTIONAL LPCWSTR lpDescription
);

Parameters

  • hDevice
    [in] Handle to the EWF-protected volume.
  • lpDescription
    [in] (Optional) Long pointer to an optional description to associate with the new overlay level. Can be up to EWF_MAX_LEVEL_NAME_LENGTH characters. If the length is equal to EWF_MAX_LEVEL_NAME_LENGTH, no null terminator is stored. This parameter is optional and can be set to NULL.

Return Value

Returns TRUE if successful; otherwise, returns FALSE. Call GetLastError for extended error information.

Remarks

The checkpoint is set on the next restart.

Warning

This function is supported on disk overlays only. The current level must be less than MaxLevels as returned by EwfMgrGetProtectedVolumeConfig. Disk mode is not supported in Windows Embedded 8 Standard (Standard 8).

Example

The DoEwfCheckPoint function that is included in EWF API Code Sample (Sample.cpp) shows you how to use the EwfMgrCheckpoint function.

Requirements

Header

ewfapi.h

Library

ewfapi.lib

See Also

Reference

EwfMgrGetProtectedVolumeConfig
EwfMgrRestore
EwfMgrSetLevel

Concepts

EWF API Functions