Documentation


GRBgetbatchattrinfo

int GRBgetbatchattrinfo ( GRBbatch *batch,
    const char *attrname,
    int *datatypeP,
    int *settableP )

Obtain information about a Batch attribute.

Return value:

A non-zero return value indicates that a problem occurred while obtaining information about a batch 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 request handle, typically created by routine GRBgetbatch.

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

datatypeP: On completion, the integer pointed to by this argument will indicate the data type of the attribute. Possible types are char (0), int (1), double (2), or string(3). This argument can be NULL.

settableP: On completion, the integer pointed to by this argument will indicate whether the attribute can be set (1) or not (0). This argument can be NULL.

Example usage:

  int datatype, settable;
  error = GRBgetbatchattrinfo(batch, "BatchID", &datatype, &settable);