CreateRangeDescriptor
You can use the CreateRangeDescriptor function to create a range descriptor record.
FUNCTION CreateRangeDescriptor (VAR rangeStart: AEDesc;
VAR rangeStop: AEDesc;
disposeInputs: Boolean;
VAR theDescriptor: AEDesc): OSErr;
rangeStart
- An object specifier record that identifies the first Apple event object in the range.
rangeStop
- An object specifier record that identifies the last Apple event object in the range.
disposeInputs
- A Boolean value indicating whether the function (
TRUE) or your application (FALSE) should dispose of the descriptor records for the rangeStart and rangeStop parameters.
theDescriptor
- The range descriptor record created by
CreateRangeDescriptor.
DESCRIPTION
The CreateRangeDescriptor function creates a range descriptor record, which specifies a series of consecutive elements in the same container. Although the rangeStart and rangeStop parameters can be any object specifier records--including object specifier records that specify more than one Apple event object--most applications expect these parameters to specify single Apple event objects.
RESULT CODES
| noErr | 0 | No error occurred |
| paramErr | -50 | Error in parameter list |
| memFullErr | -108 | Not enough room in heap zone |
| errAECoercionFail | -1700 | Data could not be coerced to the requested Apple event data type |
| errAEWrongDataType | -1703 | Wrong Apple event data type |
| errAENotAEDesc | -1704 | Not a valid descriptor record |
| errAEBadListItem | -1705 | Operation involving a list item failed |
SEE ALSO
For an example of how to use the CreateRangeDescriptor function to create a range descriptor record, see "Specifying a Range" on page 6-85.