set_component_active

Description:

public bool set_component_active (ChannelType component, bool active)

Sets if the specified image's image component is active.

This procedure sets if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive -- whether or not it can be modified. If the specified component is not valid for the image type, an error is returned.

Parameters:

this	The image.
component	The image component.
active	Component is active.

Returns:

TRUE on success.