Is field stored on self

saf_is_self_stored_field is a function defined in field.c.

Synopsis:

int saf_is_self_stored_field(SAF_ParMode pmode, SAF_Field *field, hbool_t *result)

Formal Arguments:

  • pmode: The parallel mode.
  • field: The handle of the field which is to be examined.
  • result: [OUT] Optional pointer to memory which is to receive the result of the test: true if the field is self stored or false if it is stored on a decomposition.

Description: This function is used by a client to test if a field is stored on self or on a decomposition. The boolean result is returned by reference.

Preconditions:

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

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:

  • Fields: Introduction for current chapter