File: rfio_readdir.man

package info (click to toggle)
lfc-postgres 1.7.4.7-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 13,676 kB
  • ctags: 10,779
  • sloc: ansic: 146,136; sh: 13,176; perl: 11,142; python: 5,529; cpp: 5,113; sql: 1,790; makefile: 861; fortran: 113
file content (62 lines) | stat: -rw-r--r-- 1,886 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
.\"
.\" $Id: rfio_readdir.man 3515 2010-04-05 07:51:26Z baud $
.\"
.\" @(#)$RCSfile: rfio_readdir.man,v $ $Revision: 3515 $ $Date: 2010-04-05 09:51:26 +0200 (Mon, 05 Apr 2010) $ CERN IT-PDP/DM Jean-Philippe Baud
.\" Copyright (C) 1999-2010 by CERN/IT/PDP/DM
.\" All rights reserved
.\"
.TH RFIO_READDIR 3 "$Date: 2010-04-05 09:51:26 +0200 (Mon, 05 Apr 2010) $" CASTOR "Rfio Library Functions"
.SH NAME
rfio_readdir \- read directory opened by
.B rfio_opendir
.SH SYNOPSIS
.B #include <sys/types.h>
.br
.B #include <dirent.h>
.br
\fB#include "rfio_api.h"\fR
.sp
.BI "struct dirent *rfio_readdir (RDIR *" dirp ");"
.SH DESCRIPTION
.B rfio_readdir
reads the directory opened by
.BR rfio_opendir .
This routine returns a pointer to a structure containing the current directory
entry.
.TP
.I dirp
specifies the pointer value returned by
.BR rfio_opendir .
.SH NOTES
Only the fields d_name, d_reclen and on some platforms d_namlen are filled.
For CASTOR directories, a multi-threaded application will need to initialize itself the Cthread (CASTOR Thread Interface) library ; this is done by including "shift/Cthread_api.h" and calling the function Cthread_init() at the beginning. Otherwise accessing CASTOR directories will not be thread-safe. See \fBCthread\fP(3).
.SH RETURN VALUE
This routine returns a pointer to a structure containing the current directory
entry if the operation was successful or NULL if the end of the directory was
reached or if the operation failed. In the latter case,
.B serrno
is set appropriately.
.SH ERRORS
.TP 1.3i
.B EBADF
File descriptor in DIR structure is invalid.
.TP
.B EFAULT
.I dirp
is a NULL pointer.
.TP
.B SENOSHOST
Host unknown.
.TP
.B SENOSSERV
Service unknown.
.TP
.B SECOMERR
Communication error.
.SH SEE ALSO
.BR rfio_closedir(3) ,
.BR rfio_opendir(3) ,
.BR rfio_rewinddir(3) ,
.B dirent
.SH AUTHOR
\fBCASTOR\fP Team <castor.support@cern.ch>