文字列プロパティ

文字列プロパティは、値がテキストである機能を表します。 詳細...

関数

bool  ic4_prop_string_get_value (struct IC4_PROPERTY *prop, char *buffer, size_t *buffer_size)

文字列プロパティの現在の値を読み取ります。

bool  ic4_prop_string_set_value (struct IC4_PROPERTY *prop, const char *buffer, size_t buffer_size)

文字列プロパティの値を変更します。
bool  ic4_prop_string_get_max_len (struct IC4_PROPERTY *prop, uint64_t *pMaxLength)

このプロパティに格納できる文字列の最大長を返します。

詳細説明

文字列プロパティは、値がテキストである機能を表します。

テキストの最大長は ic4_prop_string_get_max_len() で示されます。

関数ドキュメント

◆ ic4_prop_string_get_max_len()

bool ic4_prop_string_get_max_len ( struct IC4_PROPERTY *  prop,
uint64_t *  pMaxLength 
)

このプロパティに格納できる文字列の最大長を返します。

パラメータ
[in]prop文字列プロパティ
[out]pMaxLengthこのプロパティの文字列値の最大長を受け取る整数へのポインタです
戻り値
成功した場合は true、そうでない場合は false を返します。
エラー情報を問い合わせるには ic4_get_last_error() を使用してください。
備考
prop が文字列プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_prop_string_get_value()

bool ic4_prop_string_get_value ( struct IC4_PROPERTY *  prop,
char *  buffer,
size_t *  buffer_size 
)

文字列プロパティの現在の値を読み取ります。

パラメータ
[in]prop文字列プロパティ
[out]buffer文字列値を受け取る文字配列へのポインタです。
このパラメータを NULL にすると、最初に配列を確保することなく必要なサイズを調べることができます。
[in,out]buffer_sizebuffer が指す配列の長さを示す size_t へのポインタです。
この関数は常に、文字列表現の格納に実際に必要な文字数を書き込みます。
戻り値
成功した場合は true、そうでない場合は false を返します。
エラー情報を問い合わせるには ic4_get_last_error() を使用してください。
備考
prop が文字列プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
buffer が NULL でなく、かつ *buffer_size がこのプロパティの値の長さより小さい場合、関数は失敗し、エラー値は IC4_ERROR_BUFFER_TOO_SMALL に設定されます。

◆ ic4_prop_string_set_value()

bool ic4_prop_string_set_value ( struct IC4_PROPERTY *  prop,
const char *  buffer,
size_t  buffer_size 
)

文字列プロパティの値を変更します。

パラメータ
[in]prop文字列プロパティ
[in]buffer新しい文字列値を格納したバッファへのポインタです
[in]buffer_sizebuffer の長さです。
0 の場合、buffer をヌル終端文字列として解釈します。
戻り値
成功した場合は true、そうでない場合は false を返します。
エラー情報を問い合わせるには ic4_get_last_error() を使用してください。
備考
prop が文字列プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。
値が現在書き込み不可の場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_ACCESS_DENIED に設定されます。