.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\"
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng .
.TH "GFS_STAT" "3" "04 December 2003" "Gfarm" ""
.SH NAME
gfs_stat \- get file status
.SH SYNOPSIS
.sp
\fB#include
.sp
char *gfs_stat (const char * \fIgfarm_url\fB, struct gfs_stat * \fIstatus\fB);
\fR
.SH "DESCRIPTION"
.PP
\fBgfs_stat()\fR return information about the specified file pointed
to by \fIgfarm_url\fR, and fills in the buffer pointed to by
\fIstatus\fR. Since \fIstatus\fR includes a pointer to dynamically
allocated memory space, it is necessary to free the memory space by
gfs_stat_free(3).
.SH "RETURN VALUES"
.TP
\fBNULL\fR
The function terminated successfully.
.TP
\fBGFARM_ERR_NO_MEMORY\fR
Insufficient memory was available.
.TP
\fBGFARM_ERR_AUTHENTICATION\fR
User authentication failed when connecting to gfmd(8).
.TP
\fBGFARM_ERR_PERMISSION_DENIED\fR
\fIgfarm_url\fR
points outside your accessible address space.
.TP
\fBGFARM_ERR_NO_SUCH_OBJECT\fR
\fIgfarm_url\fR
does not exist.
.TP
\fBGFARM_ERR_NOT_A_DIRECTORY\fR
A component of the path prefix is not a directory.
.TP
\fBOthers\fR
An error except the above occurred. The reason is shown by its
pointed strings.
.SH "SEE ALSO"
.PP
\fBgfs_stat_free\fR(3)