CeGetFileNotificationInfo (Compact 2013)

  • Article

3/26/2014

This function obtains file notification information.

Note

FILE_NOTIFY_CHANGE_CEGETINFO must have been specified in the preceding call to the FindFirstChangeNotification function, or this function returns no data.

Syntax

BOOL CeGetFileNotificationInfo(
  HANDLE h,
  DWORD dwFlags,
  LPVOID lpBuffer,
  DWORD nBufferLength,
  LPDWORD lpBytesReturned,
  LPDWORD lpBytesAvailable
);

Parameters

  • hChangeHandle
    [in] Handle returned from FindFirstChangeNotification.
  • dwFlags
    Reserved. Set to zero.
  • lpBuffer
    [out] Pointer to a buffer.
  • nBufferLength
    [in] Length of the buffer.
  • lpBytesReturned
    [out] Number of bytes returned.
  • lpBytesAvailable
    [out] Additional change notification information available.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

If lpBuffer is set to NULL and nBufferLength is set to zero, this function sets lpBytesAvailable to the current number of bytes available to return.

When this function returns, lpBuffer contains a pointer to one or more FILE_NOTIFY_INFORMATION structures. If more notification data is available when this function returns successfully, GetLastError returns ERROR_MORE_DATA. If notifications are available but they do not fit in lpBuffer, GetLastError returns ERROR_INSUFFICIENT_BUFFER.

Requirements

Header

winbase.h

Library

coredll.lib

See Also

Reference

File I/O Functions
FindFirstChangeNotification
FindNextChangeNotification
FindCloseChangeNotification