.\" 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 "NTFS_INDEX_IGET" "9" "09 October 2005" "" ""

.SH NAME
ntfs_index_iget \- obtain a struct inode corresponding to an index
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
struct inode * ntfs_index_iget  (struct inode * \fIbase_vi\fB, ntfschar * \fIname\fB, u32 \fIname_len\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIbase_vi\fB\fR
vfs base inode containing the index related attributes
.TP
\fB\fIname\fB\fR
Unicode name of the index
.TP
\fB\fIname_len\fB\fR
length of \fIname\fR in Unicode characters
.SH "DESCRIPTION"
.PP
Obtain the (fake) struct inode corresponding to the index specified by \fIname\fR
and \fIname_len\fR, which is present in the base mft record specified by the vfs
inode \fIbase_vi\fR\&.
.PP
If the index inode is in the cache, it is just returned with an increased
reference count.  Otherwise, a new struct inode is allocated and
initialized, and finally \fBntfs_read_locked_index_inode\fR is called to read
the index related attributes and fill in the inode structure.
.PP
Return the struct inode of the index inode on success. Check the return
value with \fBIS_ERR\fR and if true, the function failed and the error code is
obtained from \fBPTR_ERR\fR\&.