Describe a basis type

saf_describe_basis is a function defined in basis.c.

Synopsis:

int saf_describe_basis(SAF_ParMode pmode, SAF_Basis *basis, char **name, char **url)

Formal Arguments:

  • basis: Basis to describe
  • name: [OUT] If non-null, on return points to malloc’d basis name if any
  • url: [OUT] If non-null, on return points to malloc’d url if any

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

Preconditions:

  • basis must be a valid basis 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: