WcsCheckColors function (icm.h)

  • Article

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

Syntax

BOOL WcsCheckColors(
  HTRANSFORM    hColorTransform,
  DWORD         nColors,
  DWORD         nInputChannels,
  COLORDATATYPE cdtInput,
  DWORD         cbInput,
  PVOID         pInputData,
  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. The size of the buffer for this array will be the number of bytes indicated by cbInput.

paResult

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

Return value

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

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header icm.h
Library Mscms.lib
DLL Mscms.dll

See also