RtmGetEntityMethods function (rtmv2.h)

Article
02/22/2024

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

Syntax

DWORD RtmGetEntityMethods(
  [in]      RTM_ENTITY_HANDLE         RtmRegHandle,
  [in]      RTM_ENTITY_HANDLE         EntityHandle,
  [in, out] PUINT                     NumMethods,
  [out]     PRTM_ENTITY_EXPORT_METHOD ExptMethods
);

Parameters

[in] RtmRegHandle

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

[in] EntityHandle

Handle to the client for which to obtain methods.

[in, out] NumMethods

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.

[out] ExptMethods

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

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_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.

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