ImageAttributes.ClearOutputChannelColorProfile method

Applies to: desktop apps only

The ImageAttributes::ClearOutputChannelColorProfile method clears the output channel color profile setting for a specified category.

Syntax

Status ClearOutputChannelColorProfile(
  [in, optional]  ColorAdjustType type
);

Parameters

type [in, optional]

Type: ColorAdjustType

Element of the ColorAdjustType enumeration that specifies the category for which the output channel profile setting is cleared. The default value is ColorAdjustTypeDefault.

Return value

Type:

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Remarks

An ImageAttributes object maintains color and grayscale settings for five adjustment categories: default, bitmap, brush, pen, and text. For example, you can specify an output channel profile for the default category and a different output channel profile for the bitmap category.

The default color- and grayscale-adjustment settings apply to all categories that don't have adjustment settings of their own. For example, if you never specify any adjustment settings for the bitmap category, then the default settings apply to the bitmap category.

As soon as you specify a color- or grayscale-adjustment setting for a certain category, the default adjustment settings no longer apply to that category. For example, suppose you specify an output channel profile and an adjustment matrix for the default category. If you set the output channel profile for the bitmap category by calling ImageAttributes::SetOutputChannelColorProfile, then the default output channel profile will not apply to bitmaps. If you later clear the bitmap output channel profile by calling ImageAttributes::ClearOutputChannelColorProfile, the bitmap category will not revert to the default output channel profile; rather, the bitmap category will have no output channel profile setting. Similarly, the bitmap category will not revert to the default color-adjustment matrix; rather, the bitmap category will have no color-adjustment matrix.

Requirements

See also

ImageAttributes

ImageAttributes::ClearOutputChannel

ColorAdjustType

ColorChannelFlags

ImageAttributes::SetOutputChannel

ImageAttributes::SetOutputChannelColorProfile

Send comments about this topic to Microsoft

Build date: 3/6/2012