RtmReleaseChangedDests function (rtmv2.h)

Article
02/22/2024

The RtmReleaseChangedDests function releases the changed destination handles.

Syntax

DWORD RtmReleaseChangedDests(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_NOTIFY_HANDLE NotifyHandle,
  [in] UINT              NumDests,
  [in] PRTM_DEST_INFO    ChangedDests
);

Parameters

[in] RtmRegHandle

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

[in] NotifyHandle

Handle to a change notification, obtained from a previous call to RtmRegisterForChangeNotification.

[in] NumDests

Specifies the number of destinations in ChangedDests.

[in] ChangedDests

Pointer to an array of RTM_DEST_INFO structures to release. The changed destinations were obtained from a prior call to RtmGetChangedDests.

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

Always use this function to release changed RTM_DEST_INFO structures obtained from a call to RtmGetChangedDests.

The RTM_DEST_INFO structure is a variable-sized structure. If a destination contains information for more than one view, the size of RTM_DEST_INFO increases for each view. Use the RTM_SIZE_OF_DEST_INFO macro to determine how large a ChangedDests buffer to allocate before calling this function.

Requirements

Requirement	Value
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