Hcon_Library_Nth_Level_Devices_Get_Options()
Abstract
Returns a list of selected devices in a specified level of a library.
Syntax
Hcon_Library_Nth_Level_Devices_Get_Options (library_ptr, level, options)
| Argument | Type | Description |
|---|---|---|
library_ptr |
HconT_Library * |
the device library to examine |
level |
int |
the level requested |
options |
int |
flag indicating which data to return |
Return Type
PrgT_List *
list of elements of type HconT_Device
Header
hcon.h
Details
This function obtains a list of selected devices at the specified level of a device library. The caller must destroy the returned list, but not the list elements. The content of the list is controlled by the following options:
HCONC_LIBRARY_DEVICE_GET_OPT_ALL—include all devices, both legacy (inactive) and non-legacy (active)HCONC_LIBRARY_DEVICE_GET_OPT_LEGACY_ONLY—include only devices declared as “legacy” in the DCR file or via Hcon_Library_Nth_Level_Device_Declare()HCONC_LIBRARY_DEVICE_GET_OPT_NONLEGACY_ONLY—include only devices not declared as “legacy”
Note: These options are exclusive; only one should be used.