Documentation


GRBdiscardbatch

int GRBdiscardbatch ( GRBbatch *batch )

This function instructs the Cluster Manager to remove all information related to the batch request in question, including the stored solution if available. Further queries for the associated batch request will fail with error code GRB_ERROR_DATA_NOT_AVAILABLE. Use this function with care, as the removed information can not be recovered later on.

Return value:

A non-zero return value indicates that a problem occurred while discarding the batch. Refer to the Error Code table for a list of possible return values. Details on the error can be obtained by calling GRBgeterrormsg.

Arguments:

batch: The batch that will be discarded.

Example usage:

  /* discard the batch object in the manager */
  error = GRBdiscardbatch(batch);
  if (error) goto QUIT;