Find suites

saf_find_suites is a function defined in suite.c.

Synopsis:

int saf_find_suites(SAF_ParMode pmode, SAF_Db *database, const char *name, int *num_suites, SAF_Suite **suites)

Formal Arguments:

  • pmode: The parallel mode.
  • database: The database in which to search.
  • name: The name to limit the search to. The constant SAF__ANY_NAME can be passed if the client does not want to limit the search by name.
  • num_suites: [OUT] The returned number of suites.
  • suites: [OUT] The returned suites.

Description: Find all the suites in a SAF database. Under the cover, this finds all sets with a SIL_ROLE of SAF__SUITE.

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:

  • Suites: Introduction for current chapter