kStatus kLight_LockOut	(	kLight	light,
		kBool	shouldLock
	)

Controls the light lockout state.

The light lockout feature can be used to suppress light output under software control. The light lockout feature can be used in any light control mode, including SetBySoftware.

The effect of the LockOut method is immediate. Lockout state is not recorded in node configuration settings and is therefore not persistent.

Light lockout is asynchronous to exposure sequences. Accordingly, lockout can occur in the middle of an exposure. Exposure sequences continue to be scheduled while light lockout is in effect.

Parameters

light	Light object.
shouldLock	Forces the output to be turned on or off.

Returns

Operation status.