Delete_Volume

#include <lvm_intr.h>

void _System Delete_Volume(

    ADDRESS      Volume_Handle,   /* (I) Handle of the volume to be deleted */
    CARDINAL32 * Error_Code       /* (O) Address where the error code will be stored */

);

Parameters

Volume_Handle

The handle of the volume to delete. All partitions which are part of the specified volume will also be deleted.

Error_Code

The address of a CARDINAL32 in which to store an error code should an error occur.

Returns

N/A.

Errors

If Volume_Handle is not a valid handle, a trap may result.

If Volume_Handle is the handle of a partition or drive, then this function will abort and an error condition will occur.

If the volume or any of its partitions can not be deleted, then this function will make no changes to the system.

If an error occurs, the value pointed to by Error_Code will be greater than 0.

Side Effects

A volume and its partitions may be deleted. System memory may be freed as the internal structures used to track the deleted volume are no longer required.

Notes

None.

16-Bit Equivalent:

void _Far16 _Pascal _loadds DELETE_VOLUME16(
        CARDINAL32          Volume_Handle,
        CARDINAL32 * _Seg16 Error_Code
);