OEMReadSnapshot (Compact 2013)

  • Article

10/16/2014

This OEM-implemented function reads data from the snapshot storage at the specified offset.

Syntax

BOOL OEMReadSnapshot(
    LPVOID pPagingMem,
    DWORD cbSize,
    DWORD dwSnapOffset);

Parameters

  • pPagingMem
    [in] Pointer to the buffer where the snapshot data is copied to.
  • cbSize
    [in] Amount of snapshot data to read, in bytes.
  • dwSnapOffset
    [in] Offset from the beginning of the snapshot where reading begins.

Return Value

Implement this function so that it returns true if successful; otherwise, return false.

Exceptions

Remarks

The OEM implements this function only if the OEM supports snapshot boot and supports paging from the snapshot image. Paging occurs when the OS calls this function to read sections of the snapshot on demand, rather than reading the entire snapshot at once.

If you implement this function, provide its address in the pfnSnapRead member of the SnapshotSupport structure. The user does not call this function. The OS calls this function while restoring from a snapshot.

Requirements

Header

Developer Implemented

Library

OEMMain.lib or OEMMain_StaticKITL.lib

See Also

Reference

Optional OAL Functions
SnapshotSupport