'\" t
.\"     Title: gfs_mkdir
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 23 Jun 2019
.\"    Manual: Gfarm
.\"    Source: Gfarm
.\"  Language: English
.\"
.TH "GFS_MKDIR" "3" "23 Jun 2019" "Gfarm" "Gfarm"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gfs_mkdir \- create a directory
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <gfarm/gfarm\&.h>
.fi
.ft
.HP \w'gfarm_error_t\ gfs_mkdir('u
.BI "gfarm_error_t\ gfs_mkdir(const\ char\ *\ " "gfarm_url" ", gfarm_mode_t\ " "mode" ");"
.SH "DESCRIPTION"
.PP
\fBgfs_mkdir()\fR
attempts to create a directory named
\fIgfarm_url\fR\&.
.PP
\fImode\fR
speficies the permissions to use\&. It is modified by the process\*(Aqs
\fIumask\fR
in the usual way: the permissions of the created file are
\fI(\fR\fImode\fR\fI & ~umask)\fR\&.
.SH "RETURN VALUES"
.PP
\fBGFARM_ERR_NO_ERROR\fR
.RS 4
The function terminated successfully\&.
.RE
.PP
\fBGFARM_ERR_NO_MEMORY\fR
.RS 4
Insufficient memory was available\&.
.RE
.PP
\fBGFARM_ERR_ALREADY_EXISTS\fR
.RS 4
\fIgfarm_url\fR
already exists (not necessarily as a directory)\&. This includes the case where
\fIgfarm_url\fR
is a symbolic link, dangling or not\&.
.RE
.PP
\fBGFARM_ERR_NO_SUCH_OBJECT\fR
.RS 4
The parent directory of
\fIgfarm_url\fR
does not exist\&.
.RE
.PP
\fBGFARM_ERR_NOT_A_DIRECTORY\fR
.RS 4
A component of the path prefix is not a directory\&.
.RE
.PP
Others
.RS 4
An error except the above occurred\&. The reason is shown by
\fBgfarm_error_string\fR(3)\&.
.RE