bpm_directory_info
status.i4.v = bpm_directory_info([directory.sa.r] [,entry.i4.v]
[,options.u4.v] [,file_range.i4a.r])
This routine returns an array of BPM file directory information
for the selected machine. See bpm_machine_c.
[directory] returned array of directory information structures
(type is BPM_DIR_ENTRY) (default is NULL)
[entry] specific directory entry requested (starts at 1)
(Note: If this argument is not specified or if a
value of BPM_ENTIRE_DIRECTORY is passed, the
entire directory will be returned.)
[options] special option selection
(BPM_OPT_NONE -> no options selected (default),
BPM_OPT_TIME_ORDER -> order meu entries in ascending
time order (default is in file
number order)
[file_range] array containing the minimum and maximum file numbers
to include (default is NULL which results in selecting
all file numbers)
This function returns status values as follows:
SQL_xxx database access error
otherwise number of directory entries in file
This function requires the following include files:
ul_cbsaux/bpmuti.h, acnet_errors_h
Related functions:
bpm_machine_c, bpm_file_menu_c, bpm_protect_file_c, bpm_rename_file_c,
bpm_set_save_file, bpm_find_oldest_file_number_c, bpm_file_menu_c,
bpm_next_unlinked_file_c, bpm_link_file_c, bpm_unlink_file_c,
bpm_file_link_info_c
C/C++ usage:
int status;
int entry = BPM_ENTIRE_DIRECTORY;
int *file_range = (int *) NULL;
unsigned int options = BPM_OPT_NONE;
BPM_DIR_ENTRY directory[BPM_ENTRIES_PER_FILE];
status = bpm_directory_info(directory,entry,options);