Register Properties
Register properties have a value represented by raw bytes. More...
Functions
bool | ic4_prop_register_get_size (struct IC4_PROPERTY *prop, uint64_t *pSize) Queries the size of a register property. |
bool | ic4_prop_register_get_value (struct IC4_PROPERTY *prop, void *buffer, size_t buffer_size) Reads data from a register property. |
bool | ic4_prop_register_set_value (struct IC4_PROPERTY *prop, const void *buffer, size_t buffer_size) Writes data to a register property. |
Detailed Description
Register properties have a value represented by raw bytes.
Function Documentation
◆ ic4_prop_register_get_size()
bool ic4_prop_register_get_size | ( | struct IC4_PROPERTY * | prop, |
uint64_t * | pSize | ||
) |
Queries the size of a register property.
The size of a register property is not necessarily constant; it can change depending on the value of other properties.
- Parameters
-
[in] prop A register property [out] pSize Pointer to a uint64_t
to receive the data size of the register in bytes.
- Remarks
- If
prop
is not a register property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.
- Returns
true
on success, otherwisefalse
.
Use ic4_get_last_error() to query error information.
◆ ic4_prop_register_get_value()
bool ic4_prop_register_get_value | ( | struct IC4_PROPERTY * | prop, |
void * | buffer, | ||
size_t | buffer_size | ||
) |
Reads data from a register property.
- Parameters
-
[in] prop A register property [out] buffer A buffer receiving the data from the property [in] buffer_size Size of buffer
in bytes. Must be equal to the size of the register property.
- Returns
true
on success, otherwisefalse
.
Use ic4_get_last_error() to query error information.
- Remarks
- If
prop
is not a register property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.
Ifbuffer_size
is not equal to the size of the property returned from ic4_prop_register_get_size(), the function fails and the error value is set to IC4_ERROR_INVALID_PARAM_VAL.
◆ ic4_prop_register_set_value()
bool ic4_prop_register_set_value | ( | struct IC4_PROPERTY * | prop, |
const void * | buffer, | ||
size_t | buffer_size | ||
) |
Writes data to a register property.
- Parameters
-
[in] prop A register property [in] buffer A buffer containing the data to be written to the property [in] buffer_size Size of buffer
in bytes. Must be equal to the size of the register property.
- Returns
true
on success, otherwisefalse
.
Use ic4_get_last_error() to query error information.
- Remarks
- If
prop
is not a register property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.
Ifbuffer_size
is not equal to the size of the property returned from ic4_prop_register_get_size(), the function fails and the error value is set to IC4_ERROR_INVALID_PARAM_VAL.