Share via

OEMPrepareSnapshot (Compact 2013)

  • Article

10/16/2014

This OEM-implemented function prepares enough storage to save the snapshot memory image.

Syntax

BOOL OEMPrepareSnapshot(
    DWORD cbSnapSize);

Parameters

  • cbSnapSize
    [in] The amount of storage, in bytes, that the OEM must reserve to store the snapshot.

Return Value

Implement this function so that it returns true if the requested amount of memory is successfully reserved; otherwise, return false.

Remarks

The OEM must implement this function if the OEM supports snapshot boot. In this function, you prepare enough flash memory to store the snapshot image. For example, because NAND flash doesn’t allow you to rewrite memory unless you first erase it, you would erase enough flash memory to make room for the snapshot. The user does not call this function. The OS calls this function when the OS is ready to take a snapshot.

When you implement this function, provide its address in the pfnPrepareSnapshot member of SnapshotSupport.

Requirements

Header

Developer Implemented

Library

OEMMain.lib or OEMMain_StaticKITL.lib

See Also

Reference

Optional OAL Functions
SnapshotSupport