$ude ("getReferenceList")

Retrieve a list of all resources (compiled runtime objects) referenced by a specified object.

$ude("getReferenceList", "symboltable;ResourceType",ResourceProfile, {"", OptionList})

Example: vResult =$ude("getreferencelist","symboltable;component", "MY_CPT","","")

Parameters

Parameters
Parameter	Data Type	Description
ResourceType	String	Type of resource that the symbol table pertains to. See Resource Types.
ResourceProfile	String	String specifying an object name of the ResourceType; wildcards are allowed.
OptionList	String	Associative list containing one or more options that are appropriate to the ObjectType. See Options.

Resource Types

Use Gold separators in specifying specific types of resources. Depending on the resource type, you can also specify additional options.

Supported Types of Resources
Resource Type	Keyword
Application shells	`application`
Components	`component`
Dynamic Server Pages	`dynamic_server_page`
Static Server Pages	`server_page`
Forms	`form`
Reports	`report`
Services	`service`
Entity Services	`entity_service`
Session Services	`session_service`
Modeled Entities	`model`
Global ProcScript	`proc`
Menus	`menu`
Panels	`panel`

Options

The OptionList enables you to specify additional resource information. For example, you can provide additional details about the resources you want to load, such as the library and language of global objects. The OptionList is an associative list containing at least one option and value. Use Gold ; in specifying multiple options.

Options
Option	Description
`library=LibraryName`	Specifies the library if ObjectType is `menu` or `panel`
`language=Language`	Specifies the language if ObjectType is `menu`
`class=Class`	Specifies the class (size and GUI platform) if ObjectType is `glyph`.

Return Values

The GetReferenceList operation returns a Uniface list, or an empty string if the list is not available. The items in the list are returned using the general format: TypeCode/ResourceName.

Resource Type	Syntax
Application shell	`APS/ApplicationName`
Component	`CPT/ComponentName`
Entity	`ENT/Entity@Model`
IncludeScript	`INC/Library`
Global ProcScript	`PRC/ProcScript@Library`
Global Variables	`VAR/$$REGISTER@Library`
Messages	`MSG/Message`
Menu	`MEN/Menu@Library@Language`
Panel	`PNL/Panel@Library`
Formats	`FMT/Format@Library@Language`
Device/Printer Tables	`DVC/TableName`
Translation Tables	`KTT/TableName`
Unicode (UTF-8)	`UNI/FileName`
Files such as map files (usysmap.dsc), readme, and help files:
Text Files	`TXT/FileName`
Binary Files, Unknown Files	`FIL/FileName`
DTDs	`DTD/Entity@Model`

Description

The $ude ("getReferenceList") creates a list of compiled runtime objects (resources) that are referenced by the specified resource. This list is created through an iterative process that extracts information from the specified symbol tables, as well as the symbol tables of referenced resources. The list therefore includes all the resources required by the specified resource, including those that are indirectly used via other resources.

One of the most useful applications of this function is to create a list of runtime objects for inclusion in a deployment archive or distribution set.

Using $ude("getReferenceList")

$result=$ude("getReferenceList","symboltable;component", "MY_CPT","","")

Produces the following output:

CPT/MY_CPT;
MSG/1763;
MSG/1634;
MSG/1806;
MSG/1500;
<snip>

INC/U;
CPT/UM2_ORDER;
CPT/UM5_ITEM;
LIB/UM_LIB;
PNL/UM5_PANEL;
MEN/UM1_STARTBAR;
ENT/NME@NM;
VAR/$$REGISTER@UM_LIB;
ENT/ORDERLINE@UORDERS;
MSG/2202;
<snip>

MEN/UM2_ORDERBAR;
ENT/ORDER@UORDERS;
ENT/ITEM@UORDERS;MEN/UM1_STARTBAR@UM_LIB@USA;
MEN/OK;
MEN/UM1_STARTMENU;
MEN/UM2_ORDERBAR@UM_LIB@USA; 
MEN/UM2_ORDERSMENU;
MEN/UM2_ITEMSMENU;
MEN/CANCEL;
MEN/OK@UM_LIB@USA;
MEN/UM1_STARTMENU@UM_LIB@USA;
MEN/UM2_ORDERSMENU@UM_LIB@USA;
MEN/UM2_ITEMSMENU@UM_LIB@USA;
CPT/UM3_SELITEM;MEN/CANCEL@UM_LIB@USA;
MEN/UM3_SELITEMBAR;
MEN/UM3_SELITEMBAR@UM_LIB@USA;
MEN/U3_SELITEMMENU;
MEN/U3_SELITEMMENU@UM_LIB@USA

History
Version	Change
9.3.01	Introduced