Name

omni_fget − The omni_fget procedure copies a file from the remote system to the local system. 

Syntax

extern unsigned long int omni_fget [_a](
       unsigned long int        ∗invoke_id,
       omni_l_handle            vmd_handle,
       omni_t_file_name         remote_file_name,
       unsigned long int        remote_file_name_length,
       omni_t_file_name         local_file_name,
       unsigned long int        local_file_name_length,
       unsigned long int        ∗size,
       omni_a_last_mod_date     ∗last_modified,
       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.  The parameter is used for asynchronous calls only. 

vmd_handleaccess: read only mechanism: by value Longword identifier of a loaded VMD definition of the remote peer.  The VMD handle is returned by the omni_define procedure. 

remote_file_nameaccess: read only mechanism: by reference The file specification (in native format) for the remote file to copy. 

remote_file_name_length
access: read only mechanism: by value The length of the remote_file_name parameter in characters.

local_file_nameaccess: read only mechanism: by reference The file specification for the local file to receive the copy. 

local_file_name_length
access: read only mechanism: by value The length of the local_file_name parameter in characters.

sizeaccess: write only mechanism: by reference optional argument Size of the file on the remote device. 

last_modifiedaccess: write only mechanism: by reference optional argument The date on which the file was last modified on the remote system.  Last modified dates before 1/1/1970 are not supported. 

modifier_object
  access: read only mechanism: by reference 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. 

ctrlaccess: read only mechanism: by reference optional argument A control structure to specify an event flag.  The ctrl parameter is the address of the control structure. 

Usage Notes

1If an error occurs while writing the file, the file will be deleted. 

2Wildcards must reduce to one file name. 

3If the local file already exists, the record attributes will be inherited from the previous version. 

4If the local file does not exist, the file created will be compatible with an FTAM-3 document type.  omni_fget will create a file with RMS record format undefined and RMS record attributes of none.