Perform a wild-card search for HDS container files


The routine searches for HDS container files whose names match a given wild-card file specification, and which are accessible using a specified mode of access. It is normally called repeatedly, returning a locator for the top-level object in a new container file on each occasion, and a null locator value (DAT__NOLOC) when no more container files remain to be located.

In normal use, the IWLD argument should be set to the value DAT__NOWLD before the first call to HDS_WILD. The value returned through this argument subsequently identifies the search context, which is retained between calls. In this way, several wild-card searches may be performed concurrently if required.

A call to HDS_EWILD should be made to annul the search context identifier when the search is complete. This will release any resources used.




FSPEC = CHARACTER  (  ) (Given)
The wild-card file specification identifying the container files required (a default file type extension of ‘.sdf’ is assumed, if not specified). The syntax of this specification depends on the host operating system (see §F.2).
The mode of access required to the container files: READ, UPDATE or WRITE (case insensitive).
IWLD = INTEGER (Given and Returned)
If a value of DAT__NOWLD is supplied on input, then a new wild-card search context will be started, a new value for IWLD will be returned, and the first HDS container file matching the file specification given in FSPEC will be located. If an IWLD value saved from a previous invocation of HDS_WILD is supplied, then the previous search context will be used and the next container file appropriate to that context will be located. In this case, the value of FSPEC is not used.
LOC = CHARACTER  ( DAT__SZLOC ) (Returned)
A primary locator to the top-level object in the next container file to satisfy the file specification given in FSPEC. A value of DAT__NOLOC will be returned (without error) if no further container files remain to be located.
STATUS = INTEGER (Given and Returned)
The global status.