Skip to content

Latest commit

 

History

History
125 lines (93 loc) · 3.59 KB

nf-rtmv2-rtmgetentitymethods.md

File metadata and controls

125 lines (93 loc) · 3.59 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.RtmGetEntityMethods
RtmGetEntityMethods function (rtmv2.h)
The RtmGetEntityMethods function queries the specified client to determine which methods are available for another client to invoke.
RtmGetEntityMethods
RtmGetEntityMethods function [RAS]
_rtmv2ref_rtmgetentitymethods
rras.rtmgetentitymethods
rtmv2/RtmGetEntityMethods
rras\rtmgetentitymethods.htm
RRAS
186f4a55-d46b-42ab-b092-dc036b011594
12/05/2018
RtmGetEntityMethods, RtmGetEntityMethods function [RAS], _rtmv2ref_rtmgetentitymethods, rras.rtmgetentitymethods, rtmv2/RtmGetEntityMethods
rtmv2.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Rtm.lib
Rtm.dll
Windows
19H1
RtmGetEntityMethods
rtmv2/RtmGetEntityMethods
c++
APIRef
kbSyntax
DllExport
Rtm.dll
RtmGetEntityMethods

RtmGetEntityMethods function

-description

The RtmGetEntityMethods function queries the specified client to determine which methods are available for another client to invoke.

-parameters

-param RtmRegHandle [in]

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

-param EntityHandle [in]

Handle to the client for which to obtain methods.

-param NumMethods [in, out]

On input, NumMethods specifies a valid pointer to a UINT value. Specify zero to return the number of methods available to be exported.

On output, NumMethods receives the number of methods exported by the client.

-param ExptMethods [out]

Receives a pointer to an RTM_ENTITY_EXPORT_METHOD structure that contains the set of method identifiers requested by the calling client.

-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_INSUFFICIENT_BUFFER
The buffer supplied is not large enough to hold all the requested information.

-remarks

Do not call another client's method directly, always use RtmInvokeMethod. The routing table manager performs error checking when using RtmInvokeMethod to ensure that the client is not unregistering or already unregistered.

If ERROR_INSUFFICIENT_BUFFER is returned, there may be some data in ExptMethods; NumMethods specifies how many methods actually fit in the buffer.

When the entity handle is no longer required, release it by calling RtmReleaseEntities.

For sample code using this function, see Obtain and Call the Exported Methods for a Client.

-see-also

RtmBlockMethods

RtmInvokeMethod