omni_get_handle_list(3sh1) — Subroutines
Name
omni_get_handle_list − The omni_get_handle_list procedure returns a definition handle of the specified class for the specified scope. When used as part of a loop, omni_get_handle_list can retrieve all of the handles of a specified class for the specified scope.
Syntax
extern unsigned long int omni_get_handle_list (
omni_l_handle scope,
omni_l_classes ∗class,
omni_l_context ∗context,
omni_l_handle ∗handle);
Arguments
scopeaccess: read only mechanism: by value A handle indicating the scope of the search. The scope parameter is typically the handle of a domain or VMD, obtained from an earlier call of omni_define, omni_get_handle_by_name, or omni_get_handle_list.
classaccess: read only mechanism: by reference One of the constants shown in the following table (defined in OMNI_DEFS) to indicate the class of the definition whose handle is to be retrieved.
| Constant | Definition Class |
| omni_c_cls_dom | Domain |
| omni_c_cls_pi | Program invocation |
| omni_c_cls_named_var | Named variable (AP only) |
| omni_c_cls_unnamed_var | Unnamed variable |
| omni_c_cls_mms_named_type | MMS Named Type |
| omni_c_cls_app_named_type | Application Named Type |
| omni_c_cls_msg | Message |
contextaccess: read only mechanism: by reference A variable for use by DEComni.
The value of this variable is modified by DEComni. It must be initialized to NULL before the first call and must not be modified by the caller until the value of the return status is omni_s_endoflist or until omni_end_list has been called.
handleaccess: write only mechanism: by reference A variable of the type omni_l_handle to receive the definition handle.
Usage Notes
Omni_get_handle_list sets the value pointed to by the receiving handle to NULL before assigning it a valid value. Even if omni_get_handle_list returns an error, the value pointed to by the receiving handle may still be zero.