omni_get_value(3sh1) — Subroutines
Name
omni_get_value − As a client procedure, omni_get_value obtains the value of a variable or of a message on a remote VMD.
As a server procedure, omni_get_value obtains the value referred to by a write or an exchange message indication.
Syntax
extern unsigned long int omni_get_value [_a](
unsigned long int ∗invoke_id,
omni_l_handle handle,
omni_l_handle method_handle,
void ∗receiving_struct,
unsigned long int receiving_struct_length,
omni_l_handle modifier_object,
omni_r_iosb ∗iosb,
omni_r_ctrl ∗ctrl);
Arguments
invoke_idaccess: write only mechanism: by reference optional argument An identifier assigned by DEComni. This parameter is used for asynchronous calls only.
handleaccess: read only mechanism: by value In a client call, the identifier of a loaded variable or message definition.
In a server call, the context value returned by the get_indications procedure call that delivered the write or the message exchange indication.
method_handleaccess: read only mechanism: by value optional argument Method_handle modifies the default presentation of a variable or a message.
receiving_struct
access: write only mechanism: by reference A data structure to receive the value of the object.
receiving_struct_length
access: read only mechanism: by value The size of the structure to receive data.
modifier_objectaccess: read only mechanism: by value optional argument Reserved for future use.
iosbaccess: write only mechanism: by reference optional argument The DEComni I/O status block. The iosb parameter is the address of the status block.
ctrl_strucaccess: read only mechanism: by reference optional argument A control structure to handle an The ctrl parameter is the address of the control structure.