Share via

WcsCheckColors

  • Article

Determines whether the colors in an array are within the output gamut of a specified WCS color transform.

BOOL WINAPI WcsCheckColors(
  __in HTRANSFORM hColorTransform,  __in DWORD nColors,  __in DWORD nInputChannels,  __in COLORDATATYPE cdtInput,  __in DWORD cbInput,  __in_bcount(cbInput)  PVOID pInputData,  __out_ecount(nColors) PBYTE paResult);

Parameters

  • hColorTransform
    A handle to the specified WCS color transform.

  • nColors
    The number of elements in the array pointed to by pInputData and paResult.

  • nInputChannels
    The number of channels per element in the array pointed to by pInputData.

  • cdtInput
    The input COLORDATATYPE color data type.

  • cbInput
    The buffer size of pInputData.

  • pInputData
    A pointer to an array of input colors. Colors in this array correspond to the color space of the source profile.

  • paResult
    A 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 and the output color data types are not compatible with the color transform, this function will convert the input color data as required.

This function fails if you use an International Color Consortium (ICC) transform is used.

Requirements

**  Windows Vista:** Included in Windows Vista and later.
**  Header:** Declared in Icm.h.
**  Library:** Use Mscms.lib.
**  Unicode:** Implemented as Unicode and ANSI versions on Windows Vista.

See Also

Basic Color Management Concepts, Windows Color System Schemas and Algorithms, Functions