.\" 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 "NTFS_ATTR_IGET" "9" "09 October 2005" "" ""
.SH NAME
ntfs_attr_iget \- obtain a struct inode corresponding to an attribute
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
struct inode * ntfs_attr_iget (struct inode * \fIbase_vi\fB, ATTR_TYPE \fItype\fB, ntfschar * \fIname\fB, u32 \fIname_len\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIbase_vi\fB\fR
vfs base inode containing the attribute
.TP
\fB\fItype\fB\fR
attribute type
.TP
\fB\fIname\fB\fR
Unicode name of the attribute (NULL if unnamed)
.TP
\fB\fIname_len\fB\fR
length of \fIname\fR in Unicode characters (0 if unnamed)
.SH "DESCRIPTION"
.PP
Obtain the (fake) struct inode corresponding to the attribute specified by
\fItype\fR, \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 attribute 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_attr_inode\fR is called to read the
attribute and fill in the inode structure.
.PP
Note, for index allocation attributes, you need to use \fBntfs_index_iget\fR
instead of \fBntfs_attr_iget\fR as working with indices is a lot more complex.
.PP
Return the struct inode of the attribute 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\&.