.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "GFARM_INITIALIZE" "3" "26 June 2010" "Gfarm" ""

.SH NAME
gfarm_initialize \- initialize the Gfarm execution environment for client
.SH SYNOPSIS
.sp
\fB#include <gfarm/gfarm.h>
.sp
gfarm_error_t gfarm_initialize (int *\fIargcp\fB, char *** \fIargvp\fB);
\fR
.SH "DESCRIPTION"
.PP
\fBgfarm_initialize()\fR initializes the Gfarm
execution environment for client application.
This function should be called before any Gfarm library API.
\fIargcp\fR is a pointer to the number of
arguments and \fIargvp\fR is a pointer to the argument vector.
.SH "RETURN VALUES"
.TP
\fBGFARM_ERR_NO_ERROR\fR
The function terminated successfully.
.TP
\fBGFARM_ERR_NO_MEMORY\fR
Insufficient memory was available.
.TP
\fBGFARM_ERR_UNKNOWN_HOST\fR
The metadata server cannot be resolved.
.TP
\fBGFARM_ERR_NETWORK_IS_UNREACHABLE\fR
Network is unrechable.
.TP
\fBGFARM_ERR_OPERATION_TIMED_OUT\fR
Connetion timeout occurs.
.TP
\fBGFARM_ERR_PROTOCOL\fR
Protocol error occurs.
.TP
\fBGFARM_ERR_BROKEN_PIPE\fR
Connection to the metadata server is broken.
.TP
\fBGFARM_ERR_PERMISSION_DENIED\fR
The requested access to the file is not allowed, or one of the
directories in \fIgfarm_url\fR did not allow search (execute)
permission.  Or, the authentication to the metadata server fails.
.TP
\fBGFARM_ERR_PROTOCOL_NOT_SUPPORTED\fR
Specified authentication protocol is not supported.
.TP
\fBGFARM_ERR_AUTHENTICATION\fR
User authentication failed when connecting to the metadata server.
.TP
\fBOthers\fR
An error except the above occurred.  The reason is shown by its
\fBgfarm_error_string\fR(3)\&.
.SH "SEE ALSO"
.PP
\fBgfarm_terminate\fR(3)