Register Properties（レジスタプロパティ）
レジスタプロパティは、生のバイト列で表現される値を持ちます。 詳細...
関数
| bool | ic4_prop_register_get_size (struct IC4_PROPERTY *prop, uint64_t *pSize) レジスタプロパティのサイズを問い合わせます。 |
| bool | ic4_prop_register_get_value (struct IC4_PROPERTY *prop, void *buffer, size_t buffer_size) レジスタプロパティからデータを読み取ります。 |
| bool | ic4_prop_register_set_value (struct IC4_PROPERTY *prop, const void *buffer, size_t buffer_size) レジスタプロパティにデータを書き込みます。 |
詳細説明
レジスタプロパティは、生のバイト列で表現される値を持ちます。
関数ドキュメント
◆ ic4_prop_register_get_size()
| bool ic4_prop_register_get_size | ( | struct IC4_PROPERTY * | prop, |
| uint64_t * | pSize | ||
| ) |
レジスタプロパティのサイズを問い合わせます。
レジスタプロパティのサイズは必ずしも一定ではなく、他のプロパティの値に応じて変化する場合があります。
- パラメータ
-
[in] prop レジスタプロパティ [out] pSize レジスタのデータサイズ（バイト単位）を受け取る uint64_tへのポインタ。
- 備考
propがレジスタプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
- 戻り値
- 成功した場合は
true、それ以外の場合はfalse。
エラー情報を問い合わせるには ic4_get_last_error() を使用します。
◆ ic4_prop_register_get_value()
| bool ic4_prop_register_get_value | ( | struct IC4_PROPERTY * | prop, |
| void * | buffer, | ||
| size_t | buffer_size | ||
| ) |
レジスタプロパティからデータを読み取ります。
- パラメータ
-
[in] prop レジスタプロパティ [out] buffer プロパティからのデータを受け取るバッファ [in] buffer_size bufferのサイズ（バイト単位）。レジスタプロパティのサイズと等しくなければなりません。
- 戻り値
- 成功した場合は
true、それ以外の場合はfalse。
エラー情報を問い合わせるには ic4_get_last_error() を使用します。
- 備考
propがレジスタプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
buffer_sizeが ic4_prop_register_get_size() から返されるプロパティのサイズと等しくない場合、関数は失敗し、エラー値は 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 | ||
| ) |
レジスタプロパティにデータを書き込みます。
- パラメータ
-
[in] prop レジスタプロパティ [in] buffer プロパティに書き込むデータを格納したバッファ [in] buffer_size bufferのサイズ（バイト単位）。レジスタプロパティのサイズと等しくなければなりません。
- 戻り値
- 成功した場合は
true、それ以外の場合はfalse。
エラー情報を問い合わせるには ic4_get_last_error() を使用します。
- 備考
propがレジスタプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
buffer_sizeが ic4_prop_register_get_size() から返されるプロパティのサイズと等しくない場合、関数は失敗し、エラー値は IC4_ERROR_INVALID_PARAM_VAL に設定されます。
