wydirent.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WyDirEnt 3wy "libwy v0.31"
.SH NAME
WyDirEnt \- class of directory entries
.SH SYNOPSIS
.B #include <wy_dirfile.h>
.PP
WyDirEnt is a discardable class for \fBstruct dirent\fP, the directory
data entry that Wy_DirFile reads.
.SH "PUBLIC MEMBERS"
 \fBWyDirEnt\fP() throw()
 \fBWyDirEnt\fP(const WyDirEnt&) throw()
 \fBWyDirEnt\fP(WyDirEnt&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 const char* \fBdt_name\fP(void) const throw()
 size_t \fBdt_reclen\fP(void) const throw()
 long \fBdt_ino\fP(void) const throw()
 off_t \fBdt_off\fP(void) const throw()
 void \fBreset\fP(void) throw()
 void \fBreset\fP(const WyDirEnt&) throw()
 void \fBswap\fP(WyDirEnt&) throw()
 const WyDirEnt& \fBoperator =\fP(const WyDirEnt&) throw()
 bool \fBoperator ==\fP(const WyDirEnt&) const throw()
 bool \fBoperator !=\fP(const WyDirEnt&) const throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "WyDirEnt() throw()"
.PP
    Construct default object

      dt_name()= point to a char(0) in *this
    dt_reclen()= 0
       dt_ino()= 0
       dt_off()= 0
.\"--------------------------------------------
.PP
.BI "WyDirEnt(const WyDirEnt& " "dent" ") throw()"
.PP
    Construct object by copy from \fIdent\fP

      dt_name()= point to a character array in *this, all
                 elements are copied from \fIdent\fP.dt_name()
    dt_reclen()= object copied from \fIdent\fP
       dt_ino()= ditto
       dt_off()= ditto
.\"--------------------------------------------
.PP
.BI "WyDirEnt(WyDirEnt& " "src" ", Wy::ByMove_t) throw()"
.PP
    See Wy_Array(Wy_Array&, Wy::ByMove_t) in wy_array(3wy)
    for definition of the move constructor.
.\"--------------------------------------------
.PP
.BI "bool is_default(void) const throw()"
.PP
    Is *this equivalent to the default object
.PP
    [\fBRet\fP] true= object is equivalent to WyDirEnt()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "const char* dt_name(void) const throw()"
.PP
    Get the pointer entry pointing to the zero-terminated
    filename string in *this.
.PP
    [\fBRet\fP] Pointer to the zero-terminated string in *this.
          Or, pointing to a char(0) if object is default. 
.\"--------------------------------------------
.PP
.BI "size_t dt_reclen(void) const throw()"
.PP
    Get the entry for the length of characters dt_name() points
    ,the trailing zero is not counted.
.PP
    [\fBRet\fP] The length of characters dt_name() returns
.\"--------------------------------------------
.PP
.BI "long dt_ino(void) const throw()"
.PP
    Get inode number entry in *this
.PP
    [\fBRet\fP] inode number
.\"--------------------------------------------
.PP
.BI "off_t dt_off(void) const throw()"
.PP
    Get offset entry in *this
.PP
    [\fBRet\fP] offset
.\"--------------------------------------------
.PP
.BI "void reset(void) throw()"
.PP
    Reconstruct *this to the state as WyDirEnt()
.\"--------------------------------------------
.PP
.BI "void reset(const WyDirEnt& " "dent" ") throw()"
.PP
    Reconstruct *this to the state as WyDirEnt(\fIdent\fP)
.\"--------------------------------------------
.PP
.BI "void swap(WyDirEnt& " "dent" ") throw()"
.PP
    Interchange state of *this with \fIdent\fP
.\"--------------------------------------------
.PP
.BI "const WyDirEnt& operator =(const WyDirEnt& " "dent" ") throw()"
.PP
    Assign *this to the state as WyDirEnt(\fIdent\fP)
.PP
    [\fBRet\fP] const reference of *this
.\"--------------------------------------------
.PP 
.BI "bool operator ==(const WyDirEnt& " "dent" ") const throw()"
.PP
.BI "bool operator !=(const WyDirEnt& " "dent" ") const throw()"
.PP 
    Test equivalence of *this with \fIdent\fP

    Two WyDirEnt objects \fBa\fP and \fBb\fP are equivalent iff
    the following expression yields true:

     (Wy::_strcmp(\fBa\fP.dt_name(),\fBb\fP.dt_name())==0)&&
     (\fBa\fP.dt_reclen()==\fBb\fP.dt_reclen())&&
     (\fBa\fP.dt_ino()==\fBb\fP.dt_ino())&&
     (\fBa\fP.dt_off()==\fBb\fP.dt_off())
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.SH "SEE ALSO"
.BR wyret
.BR wytimespec
.BR wyfifofile
.BR wy_dirfile
.BR wychrfile
.BR wyregfile
.BR wymutex
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx