Documentation


GRBgetbatchstrattr

int GRBgetbatchstrattr ( GRBbatch *batch,
    const char *attrname,
    char **valueP )

Query the value of a string-valued batch attribute.

Return value:

A non-zero return value indicates that a problem occurred while querying the attribute. 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: A batch structure, typically created by routine GRBgetbatch.

attrname: The name of a string-valued batch attribute. Available attributes are listed and described in the Attributes section of this document.

valueP: The location in which the current value of the requested attribute should be placed.

Example usage:

  /* query the last error message */
  error = GRBgetbatchstrattr(batch, "BatchErrorMessage", &errorMsg);
  if (error) goto QUIT;

Important notes:

Note that all interface routines that return string-valued attributes are returning pointers into internal Gurobi data structures. The user should copy the contents of the pointer to a different data structure before the next call to a Gurobi library routine. The user should also be careful to never modify the data pointed to by the returned character pointer.

Note that all Batch attributes are cached locally, and are only updated when you create a client-side batch object or when you explicitly update this cache (by calling the appropriate update function - GRBupdatebatch for C, update for Python, etc.).