.\" @(#)$RCSfile: lfc_delfilesbypattern.man,v $ $Revision: 1.1 $ $Date: 2007/12/13 11:59:47 $ CERN IT-GD/ITR Jean-Philippe Baud
.\" Copyright (C) 2007 by CERN/IT/GD/ITR
.\" All rights reserved
.\"
.TH LFC_DELFILESBYPATTERN 3 "$Date: 2007/12/13 11:59:47 $" LFC "LFC Library Functions"
.SH NAME
lfc_delfilesbypattern \- delete the file entries selected by pattern matching on basename
.SH SYNOPSIS
.B #include <sys/types.h>
.br
\fB#include "lfc_api.h"\fR
.sp
.BI "int lfc_delfilesbypattern (const char *" path ,
.BI "const char *" pattern ,
.BI "int " force ,
.BI "int *" nbstatuses ,
.BI "struct lfc_filestatus **" statuses )
.SH DESCRIPTION
.B lfc_delfilesbypattern
deletes the file entries selected by pattern matching on basename. If replicas
exist and the force argument is not zero, all replicas are first removed.
.TP
.I path
specifies the logical pathname relative to the current LFC directory or
the full LFC pathname.
.TP
.I pattern
allows to restrict the list of files to be deleted to entries having the basename
starting with this pattern.
.I pattern
should be terminated by a %.
.TP
.I nbstatuses
will be set to the number of replies in the array of statuses.
.TP
.I statuses
will be set to the address of an array of lfc_filestatus structures allocated
by the API. The client application is responsible for freeing the array when not
needed anymore.
.PP
.nf
.ft CW
struct lfc_filestatus {
	char		name[CA_MAXNAMELEN+1];
	int		errcode;
};
.ft
.fi
.SH RETURN VALUE
This routine returns 0 if the operation was successful or -1 if the operation
failed. In the latter case,
.B serrno
is set appropriately.
.SH ERRORS
.TP 1.3i
.B ENOENT
The named directory does not exist.
.TP
.B EACCES
Search permission is denied on a component of the
.IR path
prefix or write permission is denied on the parent directory or
the parent has the sticky bit S_ISVTX set and
.RS 1.5i
.LP
the effective user ID of the requestor does not match the owner ID of the file and
.LP
the effective user ID of the requestor does not match the owner ID of the
directory and
.LP
the file is not writable by the requestor and
.LP
the requestor does not have ADMIN privilege in the Cupv database.
.RE
.TP
.B ENOMEM
Memory could not be allocated for marshalling the request or unmarshalling
the reply.
.TP
.B EFAULT
.IR path ,
.IR pattern ,
.I nbstatuses
or
.I statuses
is a NULL pointer.
.TP
.B EEXIST
File has replicas and
.I force
is zero.
.TP
.B ENOTDIR
A component of
.I path
prefix is not a directory.
.TP
.B ENAMETOOLONG
The length of
.I path
exceeds
.B CA_MAXPATHLEN
or the length of a
.I path
component exceeds
.BR CA_MAXNAMELEN .
.TP
.B EINVAL
The length of
.I pattern
exceeds
.BR CA_MAXNAMELEN .
.TP
.B SENOSSERV
Service unknown.
.TP 
.B SEINTERNAL 
Database error.
.TP
.B SECOMERR
Communication error.
.TP
.B ENSNACT
Name server is not running or is being shutdown.
.SH SEE ALSO
.BR Castor_limits(4) ,
.BR lfc_delreplica(3) ,
.BR lfc_unlink(3)
.SH AUTHOR
\fBLCG Grid Deployment\fP Team