external C class OS_FILESYS
****

________This_external_class_defines_the_interface_to_the_underlying_operating
___system_services_which_are_defined_in_the_corresponding_c_file_os_filesys.
________This_version_is_defined_for_Posix_conformant_unix_implementations!
___Reference_should_be_made_to_Posix_specifications_for_further_detail.




Public


Features
access( name : REFERENCE, reason : CARD) : INT ;
****
________This_routine_determines_whether_or_not_the_program_has_permission_to
___carry_out_the_indicated_operation_on_the_named_file.___Zero_is_returned
___if_successful.
chdir(name : REFERENCE) : INT ;
****
________This_routine_attempts_to_make_the_new_current_directory_the_one
___named,_returning_zero_only_if_successful.
chmod(name : REFERENCE, mode : CARD) : INT ;
****
________This_routine_attempts_to_set_the_permissions_for_a_file_(mode_is
___actually_an_access-set_mask),_returning_zero_if_successful.
chown(name : REFERENCE, owner : CARD, group : CARD) : INT ;
****
________This_routine_attempts_to_change_the_ownership_of_a_file,_returning
___zero_if_successful.
closedir(handle : REFERENCE) ;
****
________This_routine_closes_the_indicated_directory.
errno : CARD ;
**** This returns an OS-dependent error code number.
fclearerr( fyle : REFERENCE) ;
****
________This_routine_clears_the_error_status_for_the_indicated_file.
fclose(fyle : REFERENCE) ;
****
________This_routine_closes_the_file_having_the_given_handle.
fflush( fyle : REFERENCE) ;
****
________This_routine_flushes_the_OS_buffer_associated_with_the_file
___indicated.__If_the_file_is_currently_being_written_to_then_the_data_will
___be_sent_to_the_file,_otherwise_the_buffer_will_be_emptied.
fgetc(fyle : REFERENCE) : OCTET ;
****
________This_routine_returns_a_single_octet_from_the_indicated_file.
fgets(buff : REFERENCE, size : CARD, chan : REFERENCE) : REFERENCE ;
****
________This_routine_fills_buff_with_a_string_of_up_to_size_octets_from_the
___indicated_channel_returning_the_number_of_octets_found_or_-1_if_an_error
___has_occurred.
fopen( name : REFERENCE, open_mode : REFERENCE) : REFERENCE ;
****
________This_routine_attempts_to_open_the_files_named_for_the_operations
___specified_in_the_mode_string.___If_void_is_returned_the_operation_has
___failed,_otherwise_the_OS-dependent_file_handle_is_returned.
fputc(oct : OCTET, fyle : REFERENCE) ;
****
________This_routine_puts_a_single_octet_into_the_indicated_file.
fread(buff : REFERENCE, size, items : CARD, fyle : REFERENCE ) : INT ;
****
________This_routine_attempts_to_read_size_items_into_buff_from_the_given
___file,_returning_the_number_read_if_successful_or_-1_if_some_error_occurred.
fseek(fyle : REFERENCE, offset : INT, relative_to : CARD) : INT ;
****
________This_routine_seeks_to_the_given_offset_from_the_relative_position
___indicated,_returning_the_position_relative_to_the_beginning_of_the_file
___if_successful,_otherwise_-1.
ftell(fyle : REFERENCE) : INT ;
****
________This_routine_returns_the_size_of_the_file_with_the_given_handle
___in_octets_or_-1_if_it_does_not_exist.
fwrite(buff : REFERENCE, size, items : CARD, fyle : REFERENCE ) : INT ;
****
________This_routine_attempts_to_write_size_items_to_the_indicated_file_from
___the_buffer,_returning_the_number_of_octets_written_if_successful,
___otherwise_-1.
ioctl(chan : INT, request : INT, arg : INT) : INT ;
****
________This_routine_is_the_standard_Unix_one_for_performing_a_wide_variety
___of_actions_in_respect_of_a_device_--_the_given_channel.___The_request_code
___may_indicate_that_the_argument_is_not_needed,_some_numeric_code_or_even
___the_address_of_some_data_structure.__Zero_is_returned_if_the_action_is
___successful.
mkdir(name : REFERENCE, permissions : CARD) : INT ;
****
________This_routine_attempts_to_create_a_directory_with_the_given_name_and
___permissions_(considered_by_the_OS_as_a_bit-set).
opendir(name : REFERENCE) : INT ;
****
________This_routine_attempts_to_open_the_named_directory,_returning_a_handle
___to_it.___The_directory_is_positioned_at_the_first_entry.__If_this_fails
___then_void_is_returned.
remove(name : REFERENCE) : INT ;
****
________This_routine_attempts_to_remove_the_named_file_from_the_filing_system.
rename( to, from : REFERENCE ) : INT ;
****
________This_routine_attempts_to_rename_the_file_called_to_to_be_called_from,
___returning_zero_if_successful.
rewinddir(handle : REFERENCE) ;
****
________This_routine_rewinds_the_indicated_directory_so_that_the_next_read
___will_yield_the_first_item_(again).
rmdir(name : REFERENCE) : INT ;
****
________This_routine_attempts_to_delete_the_named_directory,_returning_0
___if_successul,
setbuffer(fyle : REFERENCE, buff : REFERENCE, size : CARD) ;
****
________This_routine_sets_buff_(of_the_given_size)_for_use_by_the_operating
___system_when_reading/writing_from/to_the_indicated_file.
stat(name : REFERENCE, tuple : REFERENCE) : INT ;
****
________This_routine_returns_the_file_'label'_information_or_void_if_that
___is_not_available.
tempnam(dir : REFERENCE,
****
________This_routine_attempts_to_return_a_name_for_the_temporary_file
___indicated_(which_has_a_leaf_string_prefixed_as_given)
tmpfile : REFERENCE ;
****
________This_routine_creates_a_temporary_file_in_an_OS-dependent_manner_and
___returns_the_file_handle_to_it.
unlink(name : REFERENCE) ;
****
________This_routine_attempts_to_remove_a_file_of_the_given_name.
utime(name : REFERENCE, file_times : REFERENCE) : INT ;
****
________This_routine_attempts_to_alter_the_modified_and_last_accessed_times
___of_the_named_file_to_be_the_values_given,_returning_zero_if_successful.

The Sather Home Page