Carbon


CMSearchGetIndProfileFileSpec

Header: CMApplication.h Carbon status: Supported

Obtains the file specification for the profile at a specific index into a search result.

CMError CMSearchGetIndProfileFileSpec (
    CMProfileSearchRef search, 
    UInt32 index, 
    FSSpec *profileFile
);
Parameter descriptions
search

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

index

The index of the profile whose file specification you want to obtain. This is a one-based index into a set of profiles in the search result list. 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

profileFile

A pointer to a file specification. On return, this parameter points to a file specification for the profile at the location specified by index.

DISCUSSION

Before your application can call the CMSearchGetIndProfileFileSpec 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 ColorSync.

The CMSearchGetIndProfileFileSpec function obtains the Macintosh file system file specification for a profile at a specific index in the search result list.

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)