Obtain information about referenced files¶
ss_file_references
is a function defined in ssfile.c.
Synopsis:
-
ss_file_ref_t *
ss_file_references
(ss_file_t *master, size_t *nfiles, ss_file_ref_t *fileref, ss_prop_t UNUSED *props)¶
Formal Arguments:
master
: The file in questionnfiles [INOUT]
: Upon return this argument will point to the number of valid entriesfileref
: Optional pointer to an array of file reference information that will be initialized by this function and returned (if non-null) as the successful return value of this function.props
: File properties (none defined yet)
Description: A SAF database can consist of many files which reference each other. This function will return information
about all such files that might be referenced by the master
file. The caller is expected to fill in certain
members of the returned array and then use that array to call ss_file_openall.
Return Value: On success, returns either fileref
(if non-null) or an allocated array and the nfiles
argument indicates how
many elements of the return value have been initialized. Returns the null pointer on failure.
Parallel Notes: Independent.
See Also:
- ss_file_openall: 11.3: Open many files
- Files: Introduction for current chapter