AIFMODEALLOCATE

Deallocates a previously allocated magneto-optical media drive.

Syntax



                     REC      I32       I32A          

AIFMODEALLOCATE(overall_status, ldev, itemnum_array,

                     @64A        RECA         I32

                  item_array, itemstatus_array, user_id)

Parameters

overall_status

record by reference (required)

Returns the overall status of the call. A zero indicates a successful call. A negative value indicates an error in the overall call, not specific to any particular item. A positive value indicates the last element in itemstatus_array, signaling an error condition. Refer to appendix A for meanings of status values.

Record type: status_type (Refer to appendix B.)

ldev

32-bit signed integer by value (required)

The logical device number (ldev) of the optical drive to deallocate.

itemnum_array

32-bit signed integer array by reference (optional)

This is an array of integers, terminated by an element containing the value zero, used to define the corresponding option given in the item_array parameter. If this optional parameter is specified, the item_array parameter and the itemstatus_array parameter must both be supplied.

Default: nil

item_array

64-bit address array by reference (optional)

An array with the same number of elements as the itemnum_array parameter, each of which is a globalanyptr that points to the appropriate type needed by each particular item number. The value used for each option is taken from the location pointed to by the globalanyptr in this array. When this parameter is supplied, the itemnum_array parameter and the itemstatus_array parameter must both be supplied.

Array type: globalanyptr (Refer to Appendix B.)

Default: nil

itemstatus_array

record array by reference (optional)

If problems are detected with the specific items, an error status is placed in the corresponding element of this array for each item with an error. The overall_status parameter indicates whether any individual items contained errors, and the element of the last detected error. This array must contain as many elements as are contained in the itemnum_array and the item_array parameters.

A zero indicates a successful operation. A negative value indicates an error condition. A positive value indicates a warning.

Array type: status_type (Refer to Appendix B.)

Default: nil

user_id

32-bit signed integer by value (optional)

The user ID assigned to a vendor at the time of purchase of the Architected Interface Facility: Operating System product. If it is not passed, the caller must have previously called AIFACCESSON.

Default: 0

Operation Notes

AIFMODEALLOCATE provides a way to deallocate a magneto-optical drive that has been previously allocated. Once the drive is deallocated, it becomes available for other users. If the pin item is not specified, this AIF will deallocate the drive on behalf of the calling process. If the process that performed the allocate terminates before the deallocate of the drive is performed the deallocate will occur during normal process termination clean up. That is, process termination will handle cleaning up after any outstanding 'allocates' performed through the AIFs for the terminating process. Note, AIFMODEALLOCATE will succeed even though media is mounted on the allocated drive. For example, the following sequence of calls will result in a successful deallocation of a drive:

AIFMOALLOCATE

AIFMOMOUNT

AIFMODEALLOCATE

If an item is specified more than once in a call to this AIF, the first occurrence of it will be used. For example, if item 17201 (Pin) is passed in twice, the first pin value that is passed is used to perform the deallocate, and the 2nd pin value is ignored (a warning will be returned in the item status array).

Also, it should be noted that a warning or error will not be returned if a valid optical disk drive is specified and the drive is already deallocated (free).

Refer to the Programming Example in Appendix C, or the AIFMOMOUNT Operation Notes for more information.