Legacy Document

Inside Macintosh: Advanced Color Imaging Reference /

Chapter 3 - ColorSync Manager Reference for Applications and Device Drivers / ColorSync Manager Functions

Accessing Named Color Profile Values /

CMGetNamedColorName

Obtains a named color name for a specific named color index from a named color space profile.

pascal CMError CMGetNamedColorName (
CMProfileRef prof,
unsigned long index,
StringPtr name)

prof

A profile reference (page 3-63) to a named color space profile to obtain a named color name from.

index

An index value for a named color to obtain the color name for.

name

A pointer to a Pascal string. On output, a color name string.

function result

A result code of type CMError. See "Result Codes" (page 3-174) for a list of ColorSync-specific result codes.

DISCUSSION

Based on the passed color name index, the CMGetNamedColorName function does a lookup into the named color tag and returns the name. If the index is greater than the number of named colors, CMGetNamedColorName returns an error code.