RtmInvokeMethod function (rtmv2.h)

Article
02/22/2024

The RtmInvokeMethod function invokes a method exported by another client.

Syntax

DWORD RtmInvokeMethod(
  [in]      RTM_ENTITY_HANDLE         RtmRegHandle,
  [in]      RTM_ENTITY_HANDLE         EntityHandle,
  [in]      PRTM_ENTITY_METHOD_INPUT  Input,
  [in, out] PUINT                     OutputSize,
  [out]     PRTM_ENTITY_METHOD_OUTPUT Output
);

Parameters

[in] RtmRegHandle

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

[in] EntityHandle

Handle to the client whose methods are being invoked.

[in] Input

Pointer to an RTM_ENTITY_METHOD_INPUT structure that contains the method to be invoked and a common input buffer.

[in, out] OutputSize

On input, OutputSize is a pointer to a UINT value that specifies the size, in bytes, of Output.

On output, OutputSize receives a pointer to a UINT value that specifies the actual size, in bytes, of Output.

[out] Output

Receives a pointer to an array of RTM_ENTITY_METHOD_OUTPUT structures. Each structure consists of a (method identifier, correct output) tuple.

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

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