CheckColors

[This is preliminary documentation and subject to change.]

The CheckColors function determines whether the colors in an array lie within the output gamut of a specified transform.

BOOL WINAPI CheckColors(
  HTRANSFORM hColorTransform,
  PCOLOR paInputColors, 
  DWORD nColors,
  COLORTYPE ctInput,
  PBYTE paResult 
);
 

Parameters

hColorTransform

Handle to the color transform to use.

paInputColors

Pointer to an array of nColors COLOR structures to translate.

nColors

Contains the number of elements in the arrays pointed to by paInputColors and paResult.

ctInput

Specifies the input color type.

paResult

Pointer to an array of nColors bytes that receives the results of the test.

Return Values

If this function succeeds, the return value is TRUE.

If this function fails, the return value is FALSE. For extended error information, call GetLastError.

Remarks

If the input color type is not compatible with the color transform, CheckColors fails.

The function places results of the tests in the array pointed to by paResult. Each byte in the array corresponds to a COLOR element in the array pointed to by paInputColors and has an unsigned value between 0 and 255. The value 0 denotes that the color is in gamut, while a nonzero value denotes that it is out of gamut. For any integer n such that 0 < n < 255, a result value of n+1 indicates that the corresponding color is at least as far out of gamut as would be indicated by a result value of n.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in icm.h.
  Import Library: Use mscms.lib.

See Also

Color Management Overview, ICM 2.0 Functions, The COLOR Structure