WcsCheckColors function

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

Syntax


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

Parameters

hColorTransform [in]

A handle to the specified WCS color transform.

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. The size of the buffer for this array will be the number of bytes indicated by cbInput.

paResult [out]

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

See also

Basic Color Management Concepts
Windows Color System Schemas and Algorithms
Functions

 

 

Community Additions

ADD
Show: