Describe an object

saf_describe_relrep is a function defined in relrep.c.

Synopsis:

int saf_describe_relrep(SAF_ParMode pmode, SAF_RelRep *obj, char **name, char **url, int *id)

Formal Arguments:

  • obj: object to describe
  • name: If non-null, on return points to malloc’d name if any
  • url: If non-null, on return points to malloc’d url if any
  • id: If non-null, on return points to unique id

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

Preconditions:

  • pmode must be valid. (low-cost)
  • obj must be a valid relation representation 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: