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

.SH NAME
ntfs_attr_can_be_resident \- check if an attribute can be resident
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int ntfs_attr_can_be_resident  (const ntfs_volume * \fIvol\fB, const ATTR_TYPE \fItype\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIvol\fB\fR
ntfs volume to which the attribute belongs
.TP
\fB\fItype\fB\fR
attribute type which to check
.SH "DESCRIPTION"
.PP
Check whether the attribute of \fItype\fR on the ntfs volume \fIvol\fR is allowed to
be resident.  This information is derived from our ntfs knowledge and may
not be completely accurate, especially when user defined attributes are
present.  Basically we allow everything to be resident except for index
allocation and \fB$EA\fR attributes.
.PP
Return 0 if the attribute is allowed to be non-resident and -EPERM if not.
.SH "WARNING"
.PP
In the system file \fB$MFT\fR the attribute \fB$Bitmap\fR must be non-resident
otherwise windows will not boot (blue screen of death)!  We cannot
check for this here as we do not know which inode's \fB$Bitmap\fR is
being asked about so the caller needs to special case this.