Find algebraic types

saf_find_algebraics is a function defined in algebraic.c.

Synopsis:

int saf_find_algebraics(SAF_ParMode pmode, SAF_Db *db, const char *name, const char *url, htri_t indirect, int *num, SAF_Algebraic **found)

Formal Arguments:

  • db: Database in which to limit the search.
  • name: Optional name for which to search.
  • url: Optional url for which to search.
  • indirect: Optional indirect flag for which to search. The caller should pass a negative value if it is not interested in restricting 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 algebraic types in the database. The search may be limited by one or more criteria such as the name fo the algebraic type, etc.

Preconditions:

  • pmode must be valid. (low-cost)
  • db must be a valid database. (low-cost)
  • num and found 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: