IOS_DIR_$READDIR Domain/OS IOS_DIR_$READDIR
NAME
ios_dir_$readdir - read a directory
SYNOPSIS (C)
#include <apollo/base.h>
#include <apollo/ios.h>
#include <apollo/ios_dir.h>
boolean ios_dir_$readdir(
ios_$id_t &stream_id,
long &max_count,
long &dir_list_size,
ios_dir_$buf_t dir_list,
long *read_count,
status_$t *status)
SYNOPSIS (Pascal)
%include '/sys/ins/base.ins.pas';
%include '/sys/ins/ios.ins.pas';
%include '/sys/ins/ios_dir.ins.pas';
function ios_dir_$readdir(
in stream_id: ios_$id_t;
in max_count: integer32;
in dir_list_size: integer32;
out dir_list: univ ios_dir_$buf_t;
out read_count: integer32;
out status: status_$t): boolean;
SYNOPSIS (FORTRAN)
%include '/sys/ins/base.ins.ftn'
%include '/sys/ins/ios.ins.ftn'
integer*2 maxbuf
parameter (maxbuf = 1000)
integer*2 stream_id, dir_list(maxbuf)
integer*4 max_count, dir_list_size, read_count, status
logical value
value = ios_dir_$readdir(stream_id, max_count, dir_list_size,
& dir_list, read_count, status)
DESCRIPTION
Ios_dir_$readdir supplies a list of up to max_count canonical directory
entries from the directory open on stream_id, and returns true as long as
it is successful and there are entries left to read. It returns false on
failure or when the directory is exhausted.
stream_id
An ID for a stream open on a directory.
max_count
The maximum number of directory entries to read from dir_name.
dir_list_size
The number of bytes available in dir_list. ios_dir_$readdir will
not write more than dir_list_size bytes into dir_list.
dir_list
A buffer for the canonical directory entries supplied by
ios_dir_$readdir.
read_count
The number of directory entries actually supplied in dir_list.
status
The completion status. Ios_$readdir returns false with status equal
to status_$ok when there are no more entries left to read in the
directory.