CeRegGetNotificationInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function receives information about a registry change notification.

Syntax

LONG CeRegGetNotificationInfo(
    __in HANDLE hChangeHandle,
    __in DWORD dwFlags, 
    __inout_bcount(nBufferLength) __opt LPVOID lpBuffer, 
    __in DWORD nBufferLength, 
    __out LPDWORD lpBytesReturned, 
    __out LPDWORD lpBytesAvailable    );

Parameters

• hChangeHandle
  [in]Handle to a change notification handle created by the CeFindFirstRegChange function.

• dwFlags
  [in] Unused. Set to zero.

• lpBuffer
  Pointer to a buffer that receives data for the change. Can be set to NULL if the caller is only requesting the lpBytesAvailable parameter*.*

• nBufferLength
  Length of buffer in lpBuffer. This value can be set to zero if the calling function is only requesting size.

• lpBytesReturned
  [out] The number of bytes returned in lpBuffer. This value can be set to NULL if requesting only ** lpBytesAvailable.

• lpBytesAvailable
  [out] The number of bytes of notification data currently available.

Return Values

A nonzero value 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.

When this function returns, lpBuffer contains a pointer to a REG_NOTIFY_INFORMATION structure.

If more notification data is available when CeGetFileNotificationInfo returns successfully, GetLastError returns ERROR_MORE_DATA. If notifications are available, but they do not fit in lpBuffer, GetLastError returns ERROR_INSUFFICIENT_BUFFER.

Requirements

See Also

Reference

Registry Notification Functions
REG_NOTIFY_INFORMATION