Find quantities

saf_find_quantities is a function defined in quant.c.

Synopsis:

int saf_find_quantities(SAF_ParMode pmode, SAF_Db *db, const char *desc, const char *abbr, const char *url, unsigned flags, int *power, int *num, SAF_Quantity **found)

Formal Arguments:

  • db: Database in which to limit the search.
  • desc: Optional quantity description for which to search.
  • abbr: Optional abbreviation for which to search.
  • url: Optional url for which to search.
  • flags: Optional flags for which to search, or SAF__ANY_INT.
  • power: Optional base quantity powers for which to search. If the pointer is non-null then the elements can be SAF__ANY_INT for the ones in which the caller is not interested.
  • 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 quantities in the database. The search may be limited by one or more criteria such as the name of the quantity, 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: