Describe an algebraic type

saf_describe_algebraic is a function defined in algebraic.c.

Synopsis:

int saf_describe_algebraic(SAF_ParMode pmode, SAF_Algebraic *alg, char **name, char **url, hbool_t *indirect)

Formal Arguments:

  • alg: Algebraic to describe
  • name: If non-null, on return points to malloc’d algebraic name if any
  • url: If non-null, on return points to malloc’d url if any
  • indirect: If non-null, on return points to non-zero if type is indirect

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

Preconditions:

  • alg must be a valid algebraic handle. (low-cost)

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

See Also: