Declare a state template

saf_declare_state_tmpl is a function defined in stempl.c.

Synopsis:

SAF_StateTmpl * saf_declare_state_tmpl(SAF_ParMode pmode, SAF_Db *database, const char *name, int num_ftmpls, SAF_FieldTmpl *ftmpls, SAF_StateTmpl *stmpl)

Formal Arguments:

  • pmode: The parallel mode.
  • name: The name of the state template.
  • num_ftmpls: Number of field templates that will comprise this state template.
  • ftmpls: Array of field template handles.
  • stmpl: The returned state template handle.

Description: This creates a state template associated with a specified suite.

Return Value: Returns a pointer to the new state template on success; null on failure. If the caller supplies a non-null stmpl argument then this pointer will be the return value, otherwise a state template link will be allocated.

See Also: