Carbon


CMSearchGetIndProfile

Header: CMApplication.h Carbon status: Supported

Opens the profile corresponding to a specific index into a specific search result list and obtains a reference to that profile.

CMError CMSearchGetIndProfile (
    CMProfileSearchRef search, 
    UInt32 index, 
    CMProfileRef *prof
);
Parameter descriptions
search

A reference to the profile search result list containing the profile whose reference you want to obtain. For a description of the CMProfileSearchRef private data type, see CMProfileSearchRef.

index

The position of the profile in the search result list. This value is specified as a one-based index into the set of profiles of the search result. The index must be less than or equal to the value returned as the count parameter of the CMNewProfileSearch function or the CMUpdateProfileSearch function; otherwise CMSearchGetIndProfile returns a result code of cmIndexRangeErr.

prof

A pointer to a profile reference of type CMProfileRef. On return, the reference refers to the profile associated with the specified index.

DISCUSSION

Before your application can call the CMSearchGetIndProfile function, it must call the function CMNewProfileSearch to perform a profile search and produce a search result list. The search result list is a private data structure maintained by the ColorSync Manager. After your application has finished using the profile reference, it must close the reference by calling the function CMCloseProfile.

VERSION NOTES

This function is not recommended for use in ColorSync 2.5.

Starting with version 2.5, you should use the function CMIterateColorSyncFolder for profile searching.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when ColorSync 2.0 or later is present.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)