Skip to content

Commit a321b0d

Browse files
committed
✨ Add CHILDDEVICE device session parameter
1 parent 58b83b4 commit a321b0d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

include/qdmi/constants.h

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,18 @@ enum QDMI_DEVICE_SESSION_PARAMETER_T {
113113
* parameter to be set.
114114
*/
115115
QDMI_DEVICE_SESSION_PARAMETER_PASSWORD = 5,
116+
/**
117+
* @brief `QDMI_Device` The child device to establish the session with.
118+
* @details If the device manages child devices, a QDMI driver can establish
119+
* a session with those child devices by setting this session parameter to the
120+
* respective @ref QDMI_Device handle.
121+
* @par
122+
* After initialization of this session, the device will forward any function
123+
* call on this session to the job or query interface of the child device.
124+
* @note This parameter can be unset by setting this parameter to `NULL`.
125+
* @see QDMI_DEVICE_PROPERTY_CHILDDEVICES
126+
*/
127+
QDMI_DEVICE_SESSION_PARAMETER_CHILDDEVICE = 6,
116128
/**
117129
* @brief The maximum value of the enum.
118130
* @details It can be used by devices for bounds checking and validation of
@@ -121,7 +133,7 @@ enum QDMI_DEVICE_SESSION_PARAMETER_T {
121133
* @attention This value must remain the last regular member of the enum
122134
* besides the custom members and must be updated when new members are added.
123135
*/
124-
QDMI_DEVICE_SESSION_PARAMETER_MAX = 6,
136+
QDMI_DEVICE_SESSION_PARAMETER_MAX = 7,
125137
/**
126138
* @brief This enum value is reserved for a custom parameter.
127139
* @details The device defines the meaning and the type of this parameter.

0 commit comments

Comments
 (0)