Describe an evaluation type

saf_describe_evaluation is a function defined in evaluation.c.

Synopsis:

int saf_describe_evaluation(SAF_ParMode pmode, SAF_Eval *evaluation, char **name, char **url)

Formal Arguments:

  • evaluation: Evaluation to describe
  • name: If non-null, on return points to malloc’d evaluation name if any
  • url: If non-null, on return points to malloc’d url if any

Description: Breaks evaluation into its parts and returns them through pointers.

Preconditions:

  • pmode must be valid. (low-cost)
  • evaluation must be a valid evaluation handle. (low-cost)

Return Value: A non-negative value indicates success, and a negative value indicates failure. On return, the output arguments name, url, and ID will be initialized.

See Also: