rc_client_raintegration_get_menu

Gets the menu items for interacting with the RA integration dll.

Syntax

const rc_client_raintegration_menu_t* rc_client_raintegration_get_menu(
    rc_client_t* client
);

Parameters

client

The rc_client_t managing the RA integration.

Returns

Pointer to a rc_client_raintegration_menu_t object containing the menu items.

The object is managed by the integration, and does not explicitly need to be released. But a local reference should not be kept as the data may get updated by things like toggling hardcore mode.

---

typedef struct rc_client_raintegration_menu_t {
  rc_client_raintegration_menu_item_t* items;
  uint32_t num_items;
} rc_client_raintegration_menu_t;

items

An array of menu items.

num_items

The number of menu items in the array.

---

typedef struct rc_client_raintegration_menu_item_t {
  const char* label;
  uint32_t id;
  uint8_t checked;
  uint8_t enabled;
} rc_client_raintegration_menu_item_t;

label

The text associated to the menu item. Accelerator keys will be prefixed with an ampersand. (i.e. Memory &Bookmarks).

id

The unique identifier of the menu item, which should be passed to rc_client_raintegration_activate_menu_item when clicked.

checked

Non-zero if the item should be marked as active.

enabled

Zero if the item should not be clickable.

Remarks

If using the Windows menu directly (an HMENU is available), you can use rc_client_raintegration_rebuild_submenu to build the menu and rc_client_raintegration_update_menu_item when menu item changed events are risen.

Minimum version: 11.2.0

See also

rc_client_raintegration_activate_menu_item

rc_client_raintegration_rebuild_submenu

rc_client_raintegration_update_menu_item