Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 3.3 KB

nf-rtmv2-rtmreleasedests.md

File metadata and controls

123 lines (93 loc) · 3.3 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.RtmReleaseDests
RtmReleaseDests function (rtmv2.h)
The RtmReleaseDests function releases the destination handles.
RtmReleaseDests
RtmReleaseDests function [RAS]
_rtmv2ref_rtmreleasedests
rras.rtmreleasedests
rtmv2/RtmReleaseDests
rras\rtmreleasedests.htm
RRAS
eb338b7f-8461-4980-b92f-09d976661ff2
12/05/2018
RtmReleaseDests, RtmReleaseDests function [RAS], _rtmv2ref_rtmreleasedests, rras.rtmreleasedests, rtmv2/RtmReleaseDests
rtmv2.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Rtm.lib
Rtm.dll
Windows
19H1
RtmReleaseDests
rtmv2/RtmReleaseDests
c++
APIRef
kbSyntax
DllExport
Rtm.dll
RtmReleaseDests

RtmReleaseDests function

-description

The RtmReleaseDests function releases the destination handles.

-parameters

-param RtmRegHandle [in]

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

-param NumDests [in]

Specifies the number of destinations in DestInfos.

-param DestInfos [in]

Pointer to an array of RTM_DEST_INFO structures to release. The destinations were obtained from a previous call to RtmGetEnumDests.

-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

Do not use this function to release RTM_DEST_INFO structures obtained from a call to RtmGetChangedDests. Use RtmReleaseChangedDests instead.

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 DestInfos buffer to allocate before calling this function.

-see-also

RTM_DEST_INFO

RtmCreateDestEnum

RtmDeleteEnumHandle

RtmGetEnumDests