Find bases¶
saf_find_bases
is a function defined in basis.c.
Synopsis:
-
int
saf_find_bases
(SAF_ParMode pmode, SAF_Db *db, const char *name, const char *url, int *num, SAF_Basis **found)¶
Formal Arguments:
db
: Database in which to limit the search.name
: Optional name to which to limit the search.url
: Optionalurl
to which to limit the search.num
: For this and the succeeding argument [see Returned Handles].found
: For this and the preceding argument [see Returned Handles].
Description: This function allows a client to search for bases in the database. The search may be limited by one or more criteria such as the name of the basis, etc.
Preconditions:
pmode
must be valid. (low-cost)db
must be a valid database. (low-cost)num
andfound
must be compatible for return value allocation. (low-cost)
Return Value: The constant SAF__SUCCESS
is returned when this function is successful. Otherwise this function either returns
an error number or throws an exception, depending on the value of the library’s error handling property.
Parallel Notes: Depends on pmode
.
See Also:
- Basis Types: Introduction for current chapter