This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Character menus and data structures

Character menu definitions are represented by the ARCharMenuStruct structure (see the following figure).

Structures used to define character menus 

 

Most character menu functions have a menuDefn parameter that is a pointer to a structure of this type (for example, see ARCreateCharMenu or ARExpandCharMenu).

The ARCharMenuStruct structure defines both the content and organization of the menu and has the following elements:

Menu Type

Integer that specifies the type of character menu (see the following table).

Menu Definition

Menu content (represented by structures appropriate to the type of menu).


1

AR_CHAR_MENU_LIST

Menu items based on definitions in ARCharMenuList.

2

AR_CHAR_MENU_QUERY

Menu items based on schema query defined in ARCharMenuQueryStruct.

3

AR_CHAR_MENU_FILE

Menu items based on formatted flat file defined in ARCharMenuFileStruct.

4

AR_CHAR_MENU_SQL

Menu items based on SQL query defined in ARCharMenuSQLStruct.

5

AR_CHAR_MENU_SS

Menu items based on server side query defined in ARCharMenuSSStruct.

6

AR_CHAR_MENU_DATA_DICTIONARY

Menu items based on data dictionary query defined in ARCharMenuDDStruct.

The ARCharMenuList structure has zero or more ARCharMenuItemStruct items, each representing an individual menu item. In this context, a menu item can be a value (a leaf item) or another menu (a top- or intermediate-level item).

The ARCharMenuItemStruct structure has the following elements:

Label

Label that identifies the menu item.

Type

Integer that specifies the type of menu item (see the following table).

Menu Definition

Value associated with the menu item. For leaf-level items, the definition is a string containing the item text. For top- or intermediate-level items, the definition is a pointer to a child menu (represented by ARCharMenuStruct).


1

AR_MENU_TYPE_VALUE

Leaf menu item.

2

AR_MENU_TYPE_MENU

Top- or intermediate-level menu item.

Was this page helpful? Yes No Submitting... Thank you

Comments