Find field templates

saf_find_field_tmpls is a function defined in ftempl.c.

Synopsis:

int saf_find_field_tmpls(SAF_ParMode pmode, SAF_Db *db, const char *name, SAF_Algebraic *atype, SAF_Basis *basis, SAF_Quantity *quantity, int *num, SAF_FieldTmpl **found)

Formal Arguments:

  • pmode: The parallel mode.
  • db: the database context for this search (previously retrieved from base_space)
  • name: The name of the field template.
  • atype: The algebraic type to limit the search to. Pass NULL if you do not want to limit the search by this parameter.
  • basis: The basis to limit the search to. Pass NULL if you do not want to limit the search by this parameter.
  • quantity: The quantity to search for. Pass NULL if you do not want to limit the search by this parameter.
  • num: For this and the succeeding argument [see Returned Handles].
  • found: For this and the preceding argument [see Returned Handles].

Description: This function finds field templates according to specific search criteria.

Preconditions:

  • pmode must be valid. (low-cost)
  • atype must be a valid algebraic handle if supplied. (low-cost)
  • basis must be a valid basis handle if supplied. (low-cost)
  • quantity must be a valid quantity handle if supplied. (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.

See Also: