Get a description of a state template

saf_describe_state_tmpl is a function defined in stempl.c.

Synopsis:

int saf_describe_state_tmpl(SAF_ParMode pmode, SAF_StateTmpl *stmpl, char **name, int *num_ftmpls, SAF_FieldTmpl **ftmpls)

Formal Arguments:

  • pmode: The parallel mode.
  • stmpl: The state template handle.
  • name: [OUT] The returned name. Pass NULL if you do not want the name returned.
  • num_ftmpls: [OUT] The returned number of field templates which comprise this state template.
  • ftmpls: [OUT] The returned field templates.

Description: Returns a description of a state template.

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: