@@ -982,6 +982,25 @@ enum QDMI_PROGRAM_FORMAT_T {
982982 * be set via @ref QDMI_DEVICE_JOB_PARAMETER_PROGRAM.
983983 */
984984 QDMI_PROGRAM_FORMAT_CALIBRATION = 6 ,
985+ /**
986+ * @brief `QDMI_Job*`/`QDMI_Device_Job*` (@ref QDMI_Job list / @ref
987+ * QDMI_Device_Job list) A list of jobs within a batch job.
988+ * @details This program format is used to submit a batch job, i.e., a job
989+ * that consists of multiple sub-jobs. The program must be a list of jobs
990+ * created via @ref QDMI_device_create_job or @ref
991+ * QDMI_device_session_create_device_job. These jobs must be configured
992+ * completely but not submitted. If a batch job contains already submitted
993+ * jobs, @ref QDMI_job_submit or @ref QDMI_device_job_submit on the batch job
994+ * will return @ref QDMI_ERROR_BADSTATE.
995+ * @par
996+ * Querying results from a batch job directly is not possible and will result
997+ * in @ref QDMI_ERROR_NOTSUPPORTED Instead, the results must be queried from
998+ * the individual jobs after they finished. If the device supports it, each
999+ * job in the batch can be queried for its status or waited for. However,
1000+ * in any case, individual jobs in a batch cannot be canceled and this will
1001+ * result in @ref QDMI_ERROR_NOTSUPPORTED.
1002+ */
1003+ QDMI_PROGRAM_FORMAT_BATCHJOB = 7 ,
9851004 /**
9861005 * @brief The maximum value of the enum.
9871006 * @details It can be used by devices for bounds checking and validation of
@@ -990,7 +1009,7 @@ enum QDMI_PROGRAM_FORMAT_T {
9901009 * @attention This value must remain the last regular member of the enum
9911010 * besides the custom members and must be updated when new members are added.
9921011 */
993- QDMI_PROGRAM_FORMAT_MAX = 7 ,
1012+ QDMI_PROGRAM_FORMAT_MAX = 8 ,
9941013 /**
9951014 * @brief This enum value is reserved for a custom program format.
9961015 * @details The device defines the meaning and the type of this value.
0 commit comments