deleteDirectory

You use deleteDirectory to delete a directory. If you do not specify a partner then the directory is deleted under the local user ID.

You use baseDir to specify a base directory (see section “directory”) under which the directory that is to be deleted is to be searched for. The base directory name and the name specified with the dirnames attribute are combined to form the directory name.

The length of the directory name (length of baseDir plus length of dirnames) is limited and depends on the openFT version. The length is the number of characters plus 1 character if baseDir does not end with a "/".

You should note the response on a restart (see section “Restart”).

Restrictions

The directory that is to be deleted must be empty.

Format

 <deleteDirectory ref?="ID" faultIfNotExists?="yes|no" dirnames > 
   comment?
   context?
   partner?
   baseDir?
 </deleteDirectory>

Attributes

Name	Value	Meaning
ref?	string	Reference to a directory context object.
faultIfNotExists?	yes | no	The default value is no. If the directory does not exist then deleteDirectory is terminated without error. If yes is specified then deleteDirectory is terminatedwith the error code ft_notExists if the directory does not exist. On a restart (see section “Restart”), deleteDirectory is terminated with the error code ft_recovery- Failed. This may also occur if the instance is switched.
dirnames	See section “Directory name attributes”.

Example

 
 <ftscript version="1">
   <context>
     <directory id="myDir" name="myTmp"/>
   </context>
   <deleteDirectory ref="myDir">
     <partner name="UnixP_1" systemType="unix">
       <transferAdmission>
         <ftacAdmission ftacAdmission="FTACADM1"/>
       </transferAdmission>
     </partner>
     <baseDir name="frg_eis_04"/>
   </deleteDirectory>
 </ftscript>

Deletes the directory myTmp for the FTAC transfer admission FTACADM1 on the computer UnixP_1.

deleteDirectory is terminated without error if the directory does not exist or has already been deleted.

frg_eis_04 is specified as baseDir. The directory that is to be deleted is referenced. The entire directory path (baseDir + name) is frg_eis_04/myTmp and consists of 16 characters.