1 //---------------------------------------------------------------------- 2 // This software is part of the OpenBeOS distribution and is covered 3 // by the OpenBeOS license. 4 //--------------------------------------------------------------------- 5 /*! 6 \file EntryList.cpp 7 BEntryList implementation. 8 */ 9 10 #include <EntryList.h> 11 12 13 // constructor 14 //! Creates a BEntryList. 15 /*! Does nothing at this time. 16 */ 17 BEntryList::BEntryList() 18 { 19 } 20 21 22 // destructor 23 //! Frees all resources associated with this BEntryList. 24 /*! Does nothing at this time. 25 */ 26 BEntryList::~BEntryList() 27 { 28 } 29 30 31 // GetNextEntry 32 /*! \fn status_t BEntryList::GetNextEntry(BEntry *entry, bool traverse) 33 \brief Returns the BEntryList's next entry as a BEntry. 34 Places the next entry in the list in \a entry, traversing symlinks if 35 \a traverse is \c true. 36 \param entry a pointer to a BEntry to be initialized with the found entry 37 \param traverse specifies whether to follow it, if the found entry 38 is a symbolic link. 39 \note The iterator used by this method is the same one used by 40 GetNextRef(), GetNextDirents(), Rewind() and CountEntries(). 41 \return 42 - \c B_OK if successful, 43 - \c B_ENTRY_NOT_FOUND when at the end of the list, 44 - another error code (depending on the implementation of the derived class) 45 if an error occured. 46 */ 47 48 // GetNextRef 49 /*! \fn status_t BEntryList::GetNextRef(entry_ref *ref) 50 \brief Returns the BEntryList's next entry as an entry_ref. 51 Places an entry_ref to the next entry in the list into \a ref. 52 \param ref a pointer to an entry_ref to be filled in with the data of the 53 found entry 54 \note The iterator used by this method is the same one used by 55 GetNextEntry(), GetNextDirents(), Rewind() and CountEntries(). 56 \return 57 - \c B_OK if successful, 58 - \c B_ENTRY_NOT_FOUND when at the end of the list, 59 - another error code (depending on the implementation of the derived class) 60 if an error occured. 61 */ 62 63 // GetNextDirents 64 /*! \fn int32 BEntryList::GetNextDirents(struct dirent *buf, size_t length, int32 count) 65 \brief Returns the BEntryList's next entries as dirent structures. 66 Reads a number of entries into the array of dirent structures pointed to by 67 \a buf. Reads as many but no more than \a count entries, as many entries as 68 remain, or as many entries as will fit into the array at \a buf with given 69 length \a length (in bytes), whichever is smallest. 70 \param buf a pointer to a buffer to be filled with dirent structures of 71 the found entries 72 \param length the maximal number of entries to be read. 73 \note The iterator used by this method is the same one used by 74 GetNextEntry(), GetNextRef(), Rewind() and CountEntries(). 75 \return 76 - The number of dirent structures stored in the buffer, 0 when there are 77 no more entries to be read. 78 - an error code (depending on the implementation of the derived class) 79 if an error occured. 80 */ 81 82 // Rewind 83 /*! \fn status_t BEntryList::Rewind() 84 \brief Rewinds the list pointer to the beginning of the list. 85 \return 86 - \c B_OK if successful, 87 - an error code (depending on the implementation of the derived class) 88 if an error occured. 89 */ 90 91 // CountEntries 92 /*! \fn int32 BEntryList::CountEntries() 93 \brief Returns the number of entries in the list 94 \return 95 - the number of entries in the list, 96 - an error code (depending on the implementation of the derived class) 97 if an error occured. 98 */ 99 100 101 /*! Currently unused */ 102 void BEntryList::_ReservedEntryList1() {} 103 void BEntryList::_ReservedEntryList2() {} 104 void BEntryList::_ReservedEntryList3() {} 105 void BEntryList::_ReservedEntryList4() {} 106 void BEntryList::_ReservedEntryList5() {} 107 void BEntryList::_ReservedEntryList6() {} 108 void BEntryList::_ReservedEntryList7() {} 109 void BEntryList::_ReservedEntryList8() {} 110