.lo 3,2
.lm 0.rm 72
.fl bold.fl break.fl capitalize.fl hyphenate.fl index.xl.fl period
.nhd
.c;^*DELETE__DIR - Delete Directory and all Files\*
.b
.c;by ^&Rodrick A. Eldridge\&
^*
.hl1 Introduction
\*
.b
The DELETE__DIR routine will delete the directory and all files within the 
directory located on the specified device.
.b
The routine will not attempt to delete any directories or files that are not
owned by the specified UIC; or if the UIC is specified as zero, the routine
will not attempt to delete andy directories or files that are not owned by the
same UIC as the directory.
.tp 7
^*
.hl1 Using DELETE__DIR
\*
^*
.hl2 Format
\*
The following shows the format of the DELETE__DIR program:
.b
.lt
	DELETE_DIR device-name,directory,uic,flag
.el
.b
.tp 5
^*
.hl2 Arguments
\*
.lm 9
.i -9
^&device-name\&
.b
The device name of where the directory is located.
The ^&device-name\& argument is the address of a descriptor pointing to this
device name.
The trailing colon (i.e. _:) must be included as part of the device name.
.b
.tp 5
.i -9
^&directory\&
.b
The directory specification of the directory and it's contained files and
directories to be deleted.
The ^&directory\& argument is the address of a descriptor pointing to this
directory specification.
The directory must be inclosed within square brackets (i.e. _[ and _]).
.b
.tp 5
.i -9
^&uic\&
.b
User Identification Code (UIC) identifying the owner of the directory and files
to be deleted.
The ^&uic\& argument is the address of an unsigned longword that contains
the UIC.
If ^&uic\& is zero, the UIC is assumed to be that of the directory.
.b
The routine will not attempt to delete any directories or files that are not
owned by the specified UIC; or if the UIC is specified as zero, the routine
will not attempt to delete andy directories or files that are not owned by the
same UIC as the directory.
.b
.tp 5
.i -9
^&flag\&
.b
The delete flag that specifiess whether the directory itself should also be
deleted.
The ^&flag\& argument is the address of an unsigned longword which contains
this value.
.b
If the ^&flag\& value is 0, then the routine will not delete the directory,
it will only delete the files and directories inside this directory.
If the ^&flag\& value is not 0, then the routine will delete the directory
and all files and directories inside this directory.
.lm 0
^*
.hl2 Linking
\*
.b
To use the DELETE__DIR routine, link your program to the TOOLS.OLB library in
ISU__COMMON:[LIB].
.b
For example:
.b
.lt
	LINK your_program+ISU_COMMON:[LIB]TOOLS/LIBR
.el
.b
.tp 7
^*
.hl1 Condition Values Returned
\*
The following condition values may be returned by the DELETE__DIR routine:
.b
.lm 9
.i -9
^*SS$__NORMAL\*
.b
Routine successfully completed.
.b
.tp 3
.i -9
^*SS$__INSFARG\*
.b
The argument list contained fewer than the four required arguments.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$ASSIGN\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$CRELNM\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$DASSGN\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$FILESCAN\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$PARSE\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$QIO\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$SEARCH\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$SETDDIR\*.
.b
.tp 3
.i -9
Any condition values returned by ^*SYS$TRNLNM\*.
.lm 0