RtmGetEntityInfo function (rtmv2.h)

The RtmGetEntityInfo function returns information about a previously registered client.

Syntax

DWORD RtmGetEntityInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ENTITY_HANDLE EntityHandle,
  [out] PRTM_ENTITY_INFO  EntityInfo
);

[in] RtmRegHandle

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

[in] EntityHandle

Handle to the client for which to return information.

[out] EntityInfo

On input, EntityInfo is a pointer to an RTM_ENTITY_INFO structure.

On output, EntityInfo receives the requested information.

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.

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