Print Page as PDF
XPDMENU ICR (1157)

XPDMENU    ICR (1157)

Name Value
NUMBER 1157
IA # 1157
DATE CREATED 1995/03/08
CUSTODIAL PACKAGE KERNEL
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XPDMENU
NAME XPDMENU
GENERAL DESCRIPTION 
Extrinsic functions and API calls that can be used to
manage Options in the Options file. The LKOPT function is used to lookup all
options.  The ADD and DELETE functions are used to add/delete menu items.  The
OUT, RENAME, LOCK, and RLOCK are APIs used to populate certain fields for a
given option.
STATUS Active
KEYWORDS
  • KIDS
  • OPTION
  • MENU
ID XPDMENU
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
ADD 
ADD(MENU,OPT,SYN,ORD) is used to add an option to the
Menu of another option.  Return 1 if the function succeeded, 0 if it failed.
VARIABLES TYPE VARIABLES DESCRIPTION
MENU Input 
MENU is the name of the Option you want to add a menu
item to.
OPT Input 
OPT is the name of the option you want to add to the
menu item of MENU.
SYN Input 
SYN is the value you want added to the SYNONYM field
under the MENU field for OPT.
ORD Input 
ORD is the value you want added to the DISPLAY ORDER
field under the MENU field for OPT.
DELETE 
DELETE(MENU,OPT) is used to delete an option from the
Menu field of another option. Return 1 if the function succeeded, 0 if it
failed.
VARIABLES TYPE VARIABLES DESCRIPTION
MENU Input 
MENU is the name of the Option you want to delete a
menu item from.
OPT Input 
OPT is the name of the option you want to delete from
the menu item of MENU.
RENAME 
RENAME(OLD,NEW) is used to rename an option.
VARIABLES TYPE VARIABLES DESCRIPTION
OLD Input 
OLD is the current name of the option.
NEW Input 
NEW is the name the option is being renamed to.
LKOPT 
LKOPT(X) is used to lookup options IEN using the "B"
cross reference.
VARIABLES TYPE VARIABLES DESCRIPTION
X Input 
X is the name of the option.  The Option File IEN is
returned.
OUT 
OUT(OPT,TXT) is used to place an option Out of Order,
field #2.
VARIABLES TYPE VARIABLES DESCRIPTION
OPT Input 
OPT is the name of the Option you want to place
Out-of-Order.
TXT Input 
TXT is the text that will be placed in the
Out-of-Order field.
LOCK 
LOCK(OPT,TXT) is used to set the LOCK field #3, in
the OPTION file #19 for the given option.
VARIABLES TYPE VARIABLES DESCRIPTION
OPT Input 
OPT is the name of the option you want to lock.
TXT Input 
TXT is the Key name used to lock the option.  It must
match an entry in the SECURITY KEY file #19.1
RLOCK 
RLOCK(OPT,TXT) is used to set the REVERSE/NEGATIVE
field #3.01, in the OPTION file #19 for a given option.
VARIABLES TYPE VARIABLES DESCRIPTION
OPT Input 
OPT is the name of the option you want to reverse
lock.
TXT Input 
TXT is the Key name used to reverse lock the option.
It must match an entry in the SECURITY KEY file #19.1
DATE ACTIVATED 2018/05/16