Find a state template

saf_find_state_tmpl is a function defined in stempl.c.

Synopsis:

int saf_find_state_tmpl(SAF_ParMode pmode, SAF_Db *database, const char *name, int *num_stmpls, SAF_StateTmpl **stmpls)

Formal Arguments:

  • pmode: The parallel mode.
  • database: the database context for this search
  • name: The name of the state template you are searching for. Pass SAF__ANY_NAME if you do not wish to limit your search to just this name.
  • num_stmpls: For this and the succeeding argument [see Returned Handles].
  • stmpls: For this and the preceding argument [see Returned Handles].

Description: Find state templates in a 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: