Share via


EwfMgrRegisterLowSpaceNotification

3/21/2011

This function registers for a low space notification when the available bytes in the overlay reach a specified threshold.

Note

This function is only supported on disk overlays, which are not supported in the current version of Windows Embedded Standard 7.

Syntax

BOOL EwfMgrRegisterLowSpaceNotification(
  HANDLE hDevice,
  LONGLONG FreeBytesRemaining,
  LPOVERLAPPED lpOverlapped
);

Parameters

  • hDevice
    [in] Handle to the EWF overlay store volume.
  • FreeBytesRemaining
    [in] Specifies the threshold of free bytes remaining before a notification is sent.
  • lpOverlapped
    [in] Long pointer to an OVERLAPPED structure.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. Call GetLastError for extended error information.

Remarks

If lpOverlapped is NULL:

  • EwfMgrRegisterLowSpaceNotification does not return until the notification is completed or until an error occurs.
  • The fOpenForAsyncIO parameter was FALSE when EwfMgrOpenOverlayStore was called.

If lpOverlapped is non-NULL, fOpenForAsyncIO was TRUE when EwfMgrOpenOverlayStore was called.

This function is only supported on disk overlays.

The overlay store volume must remain open while this notification is outstanding. The notification is canceled automatically if the overlay store volume handle is closed.

Example

The DoEwfRegisterLowSpaceSync and DoEwfRegisterLowSpaceAsync functions included in EWF API Code Sample (Sample.cpp) show you how to use the EwfMgrRegisterLowSpaceNotification function.

Requirements

OS Versions: Standard 7

Header: Ewfapi.h

Link Library: Ewfapi.lib

See Also

Concepts

EWF API Functions