PropertyMap

コンポーネント（通常はビデオキャプチャデバイス）のプロパティインターフェースを表します。詳細...

データ構造

struct

IC4_PROPERTY_MAP

コンポーネント（通常はビデオキャプチャデバイス）のプロパティインターフェースを表します。詳細...

型定義

typedef void *(*

ic4_serialization_allocator) (size_t size)

ic4_propmap_serialize_to_memory の呼び出し中にメモリを確保するために呼び出されるコールバック関数です。

関数

struct IC4_PROPERTY_MAP *	ic4_propmap_ref (struct IC4_PROPERTY_MAP *map) PropertyMapの内部参照カウントを1つ増やします。
void	ic4_propmap_unref (struct IC4_PROPERTY_MAP *map) PropertyMapの内部参照カウントを1つ減らします。
bool	ic4_propmap_execute_command (struct IC4_PROPERTY_MAP map, const char prop_name) 既知の名前を持つコマンドを実行します。
bool	ic4_propmap_get_value_int64 (struct IC4_PROPERTY_MAP map, const char prop_name, int64_t *pValue) 既知の名前を持つプロパティの値を整数値として取得します。
bool	ic4_propmap_get_value_double (struct IC4_PROPERTY_MAP map, const char prop_name, double *pValue) 既知の名前を持つプロパティの値を double 値として取得します。
bool	ic4_propmap_get_value_bool (struct IC4_PROPERTY_MAP map, const char prop_name, bool *pValue) 既知の名前を持つプロパティの値を bool 値として取得します。
bool	ic4_propmap_get_value_string (struct IC4_PROPERTY_MAP map, const char prop_name, char buffer, size_t buffer_size) 既知の名前を持つプロパティの値を文字列値として取得します。
bool	ic4_propmap_set_value_int64 (struct IC4_PROPERTY_MAP map, const char prop_name, int64_t value) 既知の名前を持つプロパティの値を、渡された整数値に設定します。
bool	ic4_propmap_set_value_double (struct IC4_PROPERTY_MAP map, const char prop_name, double value) 既知の名前を持つプロパティの値を、渡された double 値に設定します。
bool	ic4_propmap_set_value_bool (struct IC4_PROPERTY_MAP map, const char prop_name, bool value) 既知の名前を持つプロパティの値を、渡された bool 値に設定します。
bool	ic4_propmap_set_value_string (struct IC4_PROPERTY_MAP map, const char prop_name, const char *value) 既知の名前を持つプロパティの値を、渡された文字列値に設定します。
bool	ic4_propmap_find (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つプロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_command (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つコマンドプロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_integer (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つ整数プロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_float (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つ float プロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_boolean (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つブールプロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_string (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つ文字列プロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_enumeration (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つ列挙プロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_register (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つレジスタプロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_find_category (struct IC4_PROPERTY_MAP map, const char prop_name, struct IC4_PROPERTY **ppProperty) 渡された名前を持つカテゴリプロパティを表すプロパティオブジェクトを返します。
bool	ic4_propmap_get_all (struct IC4_PROPERTY_MAP map, struct IC4_PROPERTY_LIST *ppList) PropertyMapの "Root" カテゴリから到達可能なすべてのプロパティのリストを返します。
bool	ic4_propmap_connect_chunkdata (struct IC4_PROPERTY_MAP map, struct IC4_IMAGE_BUFFER image_buffer) 渡された IC4_IMAGE_BUFFER のチャンクデータを、PropertyMap 内のチャンクプロパティのバックエンドとして使用できるようにします。
bool	ic4_propmap_serialize_to_file (struct IC4_PROPERTY_MAP map, const char path) このPropertyMap内のプロパティの状態をファイルに保存します。
bool	ic4_propmap_serialize_to_memory (struct IC4_PROPERTY_MAP map, ic4_serialization_allocator alloc, void ppData, size_t data_size) このPropertyMap内のプロパティの状態をメモリバッファに保存します。
bool	ic4_propmap_deserialize_from_file (struct IC4_PROPERTY_MAP map, const char path) このPropertyMap内のプロパティの状態を、以前に ic4_propmap_serialize_to_file によって書き込まれたファイルから復元します。
bool	ic4_propmap_deserialize_from_memory (struct IC4_PROPERTY_MAP map, const void pData, size_t data_size) このPropertyMap内のプロパティの状態を、以前に ic4_propmap_serialize_to_memory によって書き込まれたデータを含むメモリバッファから復元します。

詳細説明

コンポーネント（通常はビデオキャプチャデバイス）のプロパティインターフェースを表します。

型定義ドキュメント

◆ ic4_serialization_allocator

typedef void *(* ic4_serialization_allocator) (size_t size)

ic4_propmap_serialize_to_memory の呼び出し中にメモリを確保するために呼び出されるコールバック関数です。

パラメータ

[in] size 確保するメモリバッファのサイズ。

戻り値: 確保されたメモリバッファへのポインタ。確保できなかった場合は NULL。

注意: この関数が NULL を返した場合、ic4_propmap_serialize_to_memory の呼び出しは失敗します。

関連項目: ic4_propmap_serialize_to_memory

関数ドキュメント

◆ ic4_propmap_connect_chunkdata()

bool ic4_propmap_connect_chunkdata	(	struct IC4_PROPERTY_MAP *	map,
		struct IC4_IMAGE_BUFFER *	image_buffer
	)

渡された IC4_IMAGE_BUFFER のチャンクデータを、PropertyMap 内のチャンクプロパティのバックエンドとして使用できるようにします。

パラメータ

[in]	map	PropertyMap
[in]	image_buffer	チャンクデータを持つImageBuffer。このパラメータに `NULL` を指定すると、以前に接続されていたバッファを切断できます。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: PropertyMapは渡されたImageBufferへの参照を保持し、その寿命を延長して自動的な再利用を防ぎます。この参照は、新しいImageBufferがPropertyMapに接続されたとき、または image_buffer 引数に NULL が渡されたときに解放されます。

◆ ic4_propmap_deserialize_from_file()

bool ic4_propmap_deserialize_from_file	(	struct IC4_PROPERTY_MAP *	map,
		const char *	path
	)

このPropertyMap内のプロパティの状態を、以前に ic4_propmap_serialize_to_file によって書き込まれたファイルから復元します。

パラメータ

[in]	map	PropertyMap
[in]	path	以前に次の関数で書き込まれたファイルへのパス: ic4_propmap_serialize_to_file

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

注意: ファイルに書き込めなかったプロパティの設定が含まれている場合、関数は失敗し、エラー値は IC4_ERROR_INCOMPLETE に設定されます。

関連項目: ic4_propmap_serialize_to_file

◆ ic4_propmap_deserialize_from_memory()

bool ic4_propmap_deserialize_from_memory	(	struct IC4_PROPERTY_MAP *	map,
		const void *	pData,
		size_t	data_size
	)

このPropertyMap内のプロパティの状態を、以前に ic4_propmap_serialize_to_memory によって書き込まれたデータを含むメモリバッファから復元します。

パラメータ

[in]	map	PropertyMap
[in]	pData	次の関数で書き込まれたデータを格納するメモリバッファへのポインタ: ic4_propmap_serialize_to_memory
[in]	data_size	次が指すメモリバッファのサイズ: `pData`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

注意: メモリバッファに書き込めなかったプロパティの設定が含まれている場合、関数は失敗し、エラー値は IC4_ERROR_INCOMPLETE に設定されます。

関連項目: ic4_propmap_serialize_to_memory

◆ ic4_propmap_execute_command()

bool ic4_propmap_execute_command	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name
	)

既知の名前を持つコマンドを実行します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のコマンドプロパティの名前: `map`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のものが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それがコマンドプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find()

bool ic4_propmap_find	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つプロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_find_boolean()

bool ic4_propmap_find_boolean	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つブールプロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のブールプロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それがブールプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_category()

bool ic4_propmap_find_category	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つカテゴリプロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のカテゴリプロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それがカテゴリプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_command()

bool ic4_propmap_find_command	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つコマンドプロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のコマンドプロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それがコマンドプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_enumeration()

bool ic4_propmap_find_enumeration	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つ列挙プロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部の列挙プロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それが列挙プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_float()

bool ic4_propmap_find_float	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つ float プロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部の float プロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それが float プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_integer()

bool ic4_propmap_find_integer	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つ整数プロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部の整数プロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それが整数プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_register()

bool ic4_propmap_find_register	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つレジスタプロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のレジスタプロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それがレジスタプロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_find_string()

bool ic4_propmap_find_string	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		struct IC4_PROPERTY **	ppProperty
	)

渡された名前を持つ文字列プロパティを表すプロパティオブジェクトを返します。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部の文字列プロパティの名前: `map`
[out]	ppProperty	プロパティオブジェクトを受け取るハンドルへのポインタ。プロパティが不要になったら、ic4_prop_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。
名前 prop_name のプロパティが存在するものの、それが文字列プロパティでない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

◆ ic4_propmap_get_all()

bool ic4_propmap_get_all	(	struct IC4_PROPERTY_MAP *	map,
		struct IC4_PROPERTY_LIST **	ppList
	)

PropertyMapの "Root" カテゴリから到達可能なすべてのプロパティのリストを返します。

パラメータ

[in]	map	PropertyMap
[out]	ppList	プロパティのリストを受け取るPropertyListへのポインタ。 PropertyListが不要になったら、次を使用してオブジェクト参照を解放してください: ic4_proplist_unref().

注意: この生成されたリストにはカテゴリプロパティは含まれません。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

◆ ic4_propmap_get_value_bool()

bool ic4_propmap_get_value_bool	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		bool *	pValue
	)

既知の名前を持つプロパティの値を bool 値として取得します。

動作はプロパティの型に依存します:

ブールプロパティの場合、値は直接返されます。
列挙プロパティの場合、現在選択されているエントリの名前が true または false を表すと明確に判断できるときに値が返されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[out]	pValue	プロパティの値を受け取る double へのポインタ:

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_get_value_double()

bool ic4_propmap_get_value_double	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		double *	pValue
	)

既知の名前を持つプロパティの値を double 値として取得します。

動作はプロパティの型に依存します:

整数プロパティの場合、値は double に変換されます。
float プロパティの場合、値は直接返されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[out]	pValue	プロパティの値を受け取る double へのポインタ:

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_get_value_int64()

bool ic4_propmap_get_value_int64	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		int64_t *	pValue
	)

既知の名前を持つプロパティの値を整数値として取得します。

動作はプロパティの型に依存します:

整数プロパティの場合、値は直接返されます。
ブールプロパティの場合、返される値は 1 または 0 です。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[out]	pValue	プロパティの値を受け取る整数へのポインタ:

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_get_value_string()

bool ic4_propmap_get_value_string	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		char *	buffer,
		size_t *	buffer_size
	)

既知の名前を持つプロパティの値を文字列値として取得します。

動作はプロパティの型に依存します:

整数プロパティの場合、値は文字列に変換されます。
float プロパティの場合、値は文字列に変換されます。
ブールプロパティの場合、値は文字列 "true" または "false" に変換されます。
列挙プロパティの場合、現在選択されているエントリの名前が返されます。
文字列プロパティの場合、値は直接返されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[out]	buffer	文字列値を受け取る文字配列へのポインタ。このパラメータに `NULL` を指定すると、初期配列を確保せずに必要なサイズを調べることができます。
[in,out]	buffer_size	buffer が指す配列の長さを表す `size_t` へのポインタ。この関数は、文字列表現を格納するために必要な実際の文字数を常に書き込みます。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_ref()

struct IC4_PROPERTY_MAP * ic4_propmap_ref ( struct IC4_PROPERTY_MAP * map )

PropertyMapの内部参照カウントを1つ増やします。

パラメータ

[in] map PropertyMap

戻り値: map を介して渡されたポインタ

備考: map が NULL の場合、関数は NULL を返します。エラー値は設定されません。

関連項目: ic4_propmap_unref

◆ ic4_propmap_serialize_to_file()

bool ic4_propmap_serialize_to_file	(	struct IC4_PROPERTY_MAP *	map,
		const char *	path
	)

このPropertyMap内のプロパティの状態をファイルに保存します。

パラメータ

[in]	map	PropertyMap
[in]	path	プロパティの状態を書き込むファイルへのパス

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

注意: この関数によって保存されるプロパティの実際のセットは、PropertyMapが属するオブジェクトによって制御されます。
後でプロパティを復元するには、次を使用します: ic4_propmap_deserialize_from_file.

関連項目: ic4_propmap_deserialize_from_file; ic4_propmap_serialize_to_memory

◆ ic4_propmap_serialize_to_memory()

bool ic4_propmap_serialize_to_memory	(	struct IC4_PROPERTY_MAP *	map,
		ic4_serialization_allocator	alloc,
		void **	ppData,
		size_t *	data_size
	)

このPropertyMap内のプロパティの状態をメモリバッファに保存します。

パラメータ

[in]	map	PropertyMap
[in]	alloc	メモリバッファを確保する関数へのポインタ。たとえば、ここに `malloc` を渡すことができます。
[out]	ppData	プロパティを格納する新しく確保されたメモリバッファを受け取るポインタへのポインタ。 `alloc` が返したメモリを解放できる関数を使用して、メモリを解放する責任は呼び出し側にあります。
[out]	data_size	呼び出しによって確保されたメモリバッファのサイズを受け取る size_t へのポインタ

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

注意: この関数によって保存されるプロパティの実際のセットは、PropertyMapが属するオブジェクトによって制御されます。
後でプロパティを復元するには、次を使用します: ic4_propmap_deserialize_from_memory.

関連項目: ic4_propmap_deserialize_from_memory; ic4_propmap_serialize_to_file

◆ ic4_propmap_set_value_bool()

bool ic4_propmap_set_value_bool	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		bool	value
	)

既知の名前を持つプロパティの値を、渡された bool 値に設定します。

動作はプロパティの型に依存します:

ブールプロパティの場合、値は直接設定されます。
列挙プロパティの場合、true または false を表すと明確に判断できる名前を持つエントリがあれば、それを選択します。
コマンドプロパティの場合、value が true であればコマンドが実行されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[in]	value	次で識別されるプロパティに設定する新しい値: `prop_name`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_set_value_double()

bool ic4_propmap_set_value_double	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		double	value
	)

既知の名前を持つプロパティの値を、渡された double 値に設定します。

動作はプロパティの型に依存します:

整数プロパティの場合、値は最も近い整数に丸められます。
float プロパティの場合、値は直接設定されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[in]	value	次で識別されるプロパティに設定する新しい値: `prop_name`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_set_value_int64()

bool ic4_propmap_set_value_int64	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		int64_t	value
	)

既知の名前を持つプロパティの値を、渡された整数値に設定します。

動作はプロパティの型に依存します:

整数プロパティの場合、値は直接設定されます。
float プロパティの場合、値は直接設定されます。
For boolean properties, if the value is 1 or 0, it is set to true or false 。それ以外の値ではエラーになります。
列挙プロパティの場合、プロパティが PixelFormat であれば数値が設定されます。その他のプロパティではエラーになります。
コマンドプロパティの場合、value が 1 であればコマンドが実行されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[in]	value	次で識別されるプロパティに設定する新しい値: `prop_name`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_set_value_string()

bool ic4_propmap_set_value_string	(	struct IC4_PROPERTY_MAP *	map,
		const char *	prop_name,
		const char *	value
	)

既知の名前を持つプロパティの値を、渡された文字列値に設定します。

動作はプロパティの型に依存します:

整数プロパティの場合、文字列が解析され、見つかった整数値が設定されます。
float プロパティの場合、文字列が解析され、見つかった浮動小数点値が設定されます。
ブールプロパティの場合、文字列が true または false を表すと明確に識別できるときに値が設定されます。
列挙プロパティの場合、値に一致する名前または表示名を持つエントリが設定されます。
文字列プロパティの場合、値は直接設定されます。
コマンドプロパティの場合、value が "1"、"true"、または "execute" であればコマンドが実行されます。
その他すべてのプロパティの型では、呼び出しはエラー（IC4_ERROR_GENICAM_TYPE_MISMATCH）になります。

パラメータ

[in]	map	PropertyMap
[in]	prop_name	内部のプロパティの名前: `map`
[in]	value	次で識別されるプロパティに設定する新しい値: `prop_name`

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用してください。

備考: map 内に名前 prop_name のプロパティが存在しない場合、関数は失敗し、エラー値は IC4_ERROR_GENICAM_FEATURE_NOT_FOUND に設定されます。

◆ ic4_propmap_unref()

void ic4_propmap_unref ( struct IC4_PROPERTY_MAP * map )

PropertyMapの内部参照カウントを1つ減らします。

参照カウントが 0 に達すると、オブジェクトは破棄されます。

パラメータ

[in] map PropertyMap

備考: map が NULL の場合、関数は何も行いません。エラー値は設定されません。; IC4_PROPERTY このPropertyMapから取得したオブジェクトは、PropertyMapが破棄された後も有効なままです。

関連項目: ic4_propmap_ref