Command Properties

Command properties represent an action that can be performed by the device. More...

Functions
bool	ic4_prop_command_execute (struct IC4_PROPERTY *prop)
	Execute a command property.
bool	ic4_prop_command_is_done (struct IC4_PROPERTY *prop, bool *is_done)
	Checks whether a command has finished executing.

Detailed Description

Command properties represent an action that can be performed by the device.

A common example for a command properties is TriggerSoftware.

Function Documentation

ic4_prop_command_execute()

bool ic4_prop_command_execute

(

struct IC4_PROPERTY *

prop

)

Execute a command property.

Parameters

[in]

prop

A command property

Returns

true on success, otherwise false.
Use ic4_get_last_error() to query error information.

Remarks

If prop is not a command property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.

ic4_prop_command_is_done()

bool ic4_prop_command_is_done	(	struct IC4_PROPERTY *	prop,
		bool *	is_done
	)

Checks whether a command has finished executing.

Parameters

prop	A command property
is_done	Output parameter receiving the command's completion status. true, if the command is completed. false, if the command is still executing.

Returns

true on success, otherwise false.
Use ic4_get_last_error() to query error information.

Remarks

If the command was never executed before, the is_done is set to false.