RtmGetChangeStatus function (rtmv2.h)

Artículo
10/13/2021
Tiempo de lectura: 2 minutos

The RtmGetChangeStatus function checks whether there are pending changes that have not been retrieved with RtmGetChangedDests.

Syntax

DWORD RtmGetChangeStatus(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_NOTIFY_HANDLE NotifyHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [out] PBOOL             ChangeStatus
);

Parameters

[in] RtmRegHandle

Handle to the client obtained from a previous call to RtmRegisterEntity.

[in] NotifyHandle

Handle to a change notification.

[in] DestHandle

Handle to the destination for which to return change status.

[out] ChangeStatus

On input, ChangeStatus is a pointer to a BOOL value.

On output, ChangeStatus receives either TRUE or FALSE to indicate if the destination specified by DestHandle has a change notification pending.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value	Meaning
ERROR_INVALID_HANDLE	The handle is invalid.

Remarks

This function can be used to make portions of the client code more efficient. For example, a client may postpone some operation if there are changes that the client has not yet processed.

This function can also be used to monitor change notification in another thread.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	rtmv2.h
Library	Rtm.lib
DLL	Rtm.dll