WcsCheckColors function

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

Syntax


BOOL WcsCheckColors(
  _In_  HTRANSFORM    hColorTransform,
  _In_  DWORD         nColors,
  _In_  DWORD         nInputChannels,
  _In_  COLORDATATYPE cdtInput,
  _In_  DWORD         cbInput,
  _In_  PVOID         pInputData,
  _Out_ PBYTE         paResult
);

Parameters

hColorTransform [in]

A handle to the WCS color transform to use.

nColors [in]

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

nInputChannels [in]

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

cdtInput [in]

The input COLORDATATYPE color data type.

cbInput [in]

The buffer size of pInputData.

pInputData [in]

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

paResult [out]

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

If this function succeeds, the return value is TRUE.

If this function fails, the return value is FALSE. For extended error information, call GetLastError (described in the Microsoft Windows SDK documentation).

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 will fail if an ICC transform is used.

Requirements

Target platform

Universal

Version

Included in Windows Vista and later.

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

 

 

Send comments about this topic to Microsoft

Show: