Carbon


DMGetIndexedDisplayModeFromList

Header: Displays.h Carbon status: Modified

Obtains a display mode from the display mode list built by DMNewDisplayModeList.

OSErr DMGetIndexedDisplayModeFromList (
    DMListType panelList, 
    DMListIndexType itemIndex, 
    UInt32 reserved, 
    DMDisplayModeListIteratorUPP listIterator, 
    void *userData
);
Parameter descriptions
panelList

A value that specifies the list from which to obtain information about the display modes created by the function DMNewDisplayModeList.

itemIndex

A value that specifies the index of the display mode you wish to obtain.

reserved

Reserved for future expansion. Pass NULL in this parameter.

listIterator

A universal procedure pointer. The iterator this pointer specifies supplies the function to be called with the information about the display mode specified by theListCount.

userData

A pointer you pass for listIterator usually used to obtain information about the display mode from the UPP and return it to the caller of DMGetIndexedDisplayModeFromList.

function result

A result code.

SPECIAL CONSIDERATIONS

Because this function may move or purge memory blocks or access handles, you cannot call it at interrupt time.

Generally, your application should not use this function, but should instead allow system software to maintain the device list. This function is described here for completeness only.

AVAILABILITY

Modified in Carbon. Available in Carbon 1.0.2 and later when Displays 2.0 or later is present.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)