omni_get_attribute(3) — Subroutines
Name
omni_get_attribute − The omni_get_attribute procedure obtains a specific object attribute from a list of attributes obtained by the omni_get_remote_attribute procedure, and a file specification from a remote directory obtained by the omni_fdir procedure.
Syntax
extern unsigned long int omni_get_attribute (
omni_l_context context,
omni_l_attributes ∗attribute,
void ∗receive_struct,
unsigned long int receive_struct_length);
Arguments
contextaccess: read only mechanism: by reference A context value returned by the omni_get_remote_attributes or omni_fdir procedure.
attributeaccess: read only mechanism: by reference One of the constants listed in the following table to specify the attribute to read. See usage note 2.
receive_structaccess: write only mechanism: by reference The address of a buffer in which the attribute value is returned as shown in the following table.
| General Constants | Data Type |
| omni_c_attr_name | omni_t_mms_id_nt |
| omni_c_attr_deletable | omni_b_boolean |
| omni_c_attr_sharable | omni_b_boolean |
| omni_c_attr_state | omni_l_pi_states |
| omni_c_attr_capability | omni_t_capability |
| omni_c_attr_additional_detail | omni_l_handle |
| VMD Constants | Data Type |
| omni_c_attr_vendor | omni_t_visible_str_127_nt |
| omni_c_attr_model | omni_t_visible_str_127_nt |
| omni_c_attr_revision | omni_t_visible_str_127_nt |
| omni_c_attr_syntax_list | omni_t_object_id_nt |
| omni_c_attr_logical_status | omni_l_logical_status |
| omni_c_attr_physical_status | omni_l_physical_status |
| omni_c_attr_local_detail | omni_a_local_detail |
| Domain Constants | Data Type |
| omni_c_attr_upld_in_progress | omni_b_boolean |
| omni_c_attr_ref_pi_names | omni_t_mms_id |
| PI Constants | Data Type |
| omni_c_attr_reusable | omni_b_boolean |
| omni_c_attr_monitor | omni_b_boolean |
| omni_c_attr_exec_arg | omni_t_visible_str_255_nt |
| omni_c_attr_ref_dom_names | omni_t_mms_id_nt |
| Variable Constants | Data Type |
| omni_c_attr_mms_type_spec | omni_r_mms_type_spec |
| omni_c_attr_address | omni_r_address |
receive_struct_lengthaccess: write only mechanism: by value The length of the receive_struct in characters.
Usage Notes
1The receive structure is based on the type of attribute,
2The omni_get_attribute procedure reads the first value of the specified type. To read the next value of the same type, call omni_get_attribute with a NULL attribute.