Skip to content

Latest commit

 

History

History
137 lines (93 loc) · 3.35 KB

nf-rtmv2-rtmgetchangestatus.md

File metadata and controls

137 lines (93 loc) · 3.35 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:rtmv2.RtmGetChangeStatus
RtmGetChangeStatus function (rtmv2.h)
The RtmGetChangeStatus function checks whether there are pending changes that have not been retrieved with RtmGetChangedDests.
RtmGetChangeStatus
RtmGetChangeStatus function [RAS]
_rtmv2ref_rtmgetchangestatus
rras.rtmgetchangestatus
rtmv2/RtmGetChangeStatus
rras\rtmgetchangestatus.htm
RRAS
fafe465a-6c89-45b0-83a9-f08d1d9546c6
12/05/2018
RtmGetChangeStatus, RtmGetChangeStatus function [RAS], _rtmv2ref_rtmgetchangestatus, rras.rtmgetchangestatus, rtmv2/RtmGetChangeStatus
rtmv2.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Rtm.lib
Rtm.dll
Windows
19H1
RtmGetChangeStatus
rtmv2/RtmGetChangeStatus
c++
APIRef
kbSyntax
DllExport
Rtm.dll
RtmGetChangeStatus

RtmGetChangeStatus function

-description

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

-parameters

-param RtmRegHandle [in]

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

-param NotifyHandle [in]

Handle to a change notification.

-param DestHandle [in]

Handle to the destination for which to return change status.

-param ChangeStatus [out]

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.

-returns

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.

-see-also

RTM_EVENT_CALLBACK

RtmGetChangedDests

RtmIgnoreChangedDests

RtmIsMarkedForChangeNotification

RtmMarkDestForChangeNotification

RtmReleaseChangedDests