diff --git a/Aaru.CommonTypes/Interfaces/IBaseWritableImage.cs b/Aaru.CommonTypes/Interfaces/IBaseWritableImage.cs index 47e47b168..8381cf2e5 100644 --- a/Aaru.CommonTypes/Interfaces/IBaseWritableImage.cs +++ b/Aaru.CommonTypes/Interfaces/IBaseWritableImage.cs @@ -77,7 +77,7 @@ public interface IBaseWritableImage : IBaseImage /// that will be written in the image /// Options to be used when creating new image /// How many sectors the media has. - /// + /// Size of each sector in bytes. /// true if operating completed successfully, false otherwise bool Create(string path, MediaType mediaType, Dictionary options, ulong sectors, uint sectorSize); diff --git a/Aaru.CommonTypes/Interfaces/IMediaImage.cs b/Aaru.CommonTypes/Interfaces/IMediaImage.cs index 5c1df2e91..7f71a9173 100644 --- a/Aaru.CommonTypes/Interfaces/IMediaImage.cs +++ b/Aaru.CommonTypes/Interfaces/IMediaImage.cs @@ -54,53 +54,53 @@ public interface IMediaImage : IBaseImage /// Reads a sector's user data. /// The sector's user data. /// Sector address (LBA). - /// - /// - /// + /// If the sector address is a negative LBA. + /// The sector's user data. + /// The status of the sector. ErrorNumber ReadSector(ulong sectorAddress, bool negative, out byte[] buffer, out SectorStatus sectorStatus); /// Reads a complete sector (user data + all tags). /// The complete sector. Format depends on disk type. /// Sector address (LBA). - /// - /// - /// + /// If the sector address is a negative LBA. + /// The complete sector. + /// The status of the sector. ErrorNumber ReadSectorLong(ulong sectorAddress, bool negative, out byte[] buffer, out SectorStatus sectorStatus); /// Reads user data from several sectors. /// The sectors user data. /// Starting sector address (LBA). - /// + /// If the sector address is a negative LBA. /// How many sectors to read. - /// - /// + /// The sectors user data. + /// The status of each sector. ErrorNumber ReadSectors(ulong sectorAddress, bool negative, uint length, out byte[] buffer, out SectorStatus[] sectorStatus); /// Reads several complete sector (user data + all tags). /// The complete sectors. Format depends on disk type. /// Starting sector address (LBA). - /// + /// If the sector address is a negative LBA. /// How many sectors to read. - /// - /// + /// The complete sectors. + /// The status of each sector. ErrorNumber ReadSectorsLong(ulong sectorAddress, bool negative, uint length, out byte[] buffer, out SectorStatus[] sectorStatus); /// Reads tag from several sectors. /// The sectors tag. /// Starting sector address (LBA). - /// + /// If the sector address is a negative LBA. /// How many sectors to read. /// Tag type. - /// + /// The sectors tag. ErrorNumber ReadSectorsTag(ulong sectorAddress, bool negative, uint length, SectorTagType tag, out byte[] buffer); /// Reads a sector's tag. /// The sector's tag. /// Sector address (LBA). - /// + /// If the sector address is a negative LBA. /// Tag type. - /// + /// The sector's tag. ErrorNumber ReadSectorTag(ulong sectorAddress, bool negative, SectorTagType tag, out byte[] buffer); } \ No newline at end of file diff --git a/Aaru.CommonTypes/Interfaces/IOpticalMediaImage.cs b/Aaru.CommonTypes/Interfaces/IOpticalMediaImage.cs index acbf17e60..227c423d0 100644 --- a/Aaru.CommonTypes/Interfaces/IOpticalMediaImage.cs +++ b/Aaru.CommonTypes/Interfaces/IOpticalMediaImage.cs @@ -62,8 +62,8 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// The sector's user data. /// Sector address (relative LBA). /// Track. - /// - /// + /// The sector's user data. + /// The status of the sector. ErrorNumber ReadSector(ulong sectorAddress, uint track, out byte[] buffer, out SectorStatus sectorStatus); /// Reads a sector's tag, relative to track. @@ -71,7 +71,7 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// Sector address (relative LBA). /// Track. /// Tag type. - /// + /// The sector's tag. ErrorNumber ReadSectorTag(ulong sectorAddress, uint track, SectorTagType tag, out byte[] buffer); /// Reads user data from several sectors, relative to track. @@ -79,8 +79,8 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// Starting sector address (relative LBA). /// How many sectors to read. /// Track. - /// - /// + /// The sectors user data. + /// The status of each sector. ErrorNumber ReadSectors(ulong sectorAddress, uint length, uint track, out byte[] buffer, out SectorStatus[] sectorStatus); @@ -90,15 +90,15 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// How many sectors to read. /// Track. /// Tag type. - /// + /// The sectors tag. ErrorNumber ReadSectorsTag(ulong sectorAddress, uint length, uint track, SectorTagType tag, out byte[] buffer); /// Reads a complete sector (user data + all tags), relative to track. /// The complete sector. Format depends on disk type. /// Sector address (relative LBA). /// Track. - /// - /// + /// The complete sector. + /// The status of the sector. ErrorNumber ReadSectorLong(ulong sectorAddress, uint track, out byte[] buffer, out SectorStatus sectorStatus); /// Reads several complete sector (user data + all tags), relative to track. @@ -106,8 +106,8 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// Starting sector address (relative LBA). /// How many sectors to read. /// Track. - /// - /// + /// The complete sectors. + /// The status of each sector. ErrorNumber ReadSectorsLong(ulong sectorAddress, uint length, uint track, out byte[] buffer, out SectorStatus[] sectorStatus); @@ -126,8 +126,8 @@ public interface IOpticalMediaImage : IMediaImage, IPartitionableMediaImage, IVe /// Starting sector address (relative LBA). /// How many sectors to read. /// Track. - /// List of incorrect sectors - /// List of uncheckable sectors + /// List of incorrect sectors. + /// List of uncheckable sectors. bool? VerifySectors(ulong sectorAddress, uint length, uint track, out List failingLbas, out List unknownLbas); } \ No newline at end of file diff --git a/Aaru.CommonTypes/Interfaces/IReadOnlyFilesystem.cs b/Aaru.CommonTypes/Interfaces/IReadOnlyFilesystem.cs index 6688a698b..6951e5d1d 100644 --- a/Aaru.CommonTypes/Interfaces/IReadOnlyFilesystem.cs +++ b/Aaru.CommonTypes/Interfaces/IReadOnlyFilesystem.cs @@ -70,8 +70,8 @@ public interface IReadOnlyFilesystem : IFilesystem /// Initializes whatever internal structures the filesystem plugin needs to be able to read files and directories /// from the filesystem. /// - /// - /// + /// The image plugin containing the filesystem. + /// The partition containing the filesystem. /// Which encoding to use for this filesystem. /// Dictionary of key=value pairs containing options to pass to the filesystem /// Filename namespace @@ -102,16 +102,19 @@ public interface IReadOnlyFilesystem : IFilesystem /// Gets information about the mounted volume. /// Information about the mounted volume. + /// Error number. ErrorNumber StatFs(out FileSystemInfo stat); /// Gets information about a file or directory. /// File path. /// File information. + /// Error number. ErrorNumber Stat(string path, out FileEntryInfo stat); /// Solves a symbolic link. /// Link path. /// Link destination. + /// Error number. ErrorNumber ReadLink(string path, out string dest); /// Opens a file for reading. @@ -155,6 +158,7 @@ public interface IReadOnlyFilesystem : IFilesystem /// Bytes to read. /// Buffer. Must exist and be of size equal or bigger than /// How many bytes were read into the buffer + /// Error number. ErrorNumber ReadFile(IFileNode node, long length, byte[] buffer, out long read); /// Opens a directory for listing. diff --git a/Aaru.CommonTypes/Interfaces/IWritableImage.cs b/Aaru.CommonTypes/Interfaces/IWritableImage.cs index 83cbde5e6..c554806ae 100644 --- a/Aaru.CommonTypes/Interfaces/IWritableImage.cs +++ b/Aaru.CommonTypes/Interfaces/IWritableImage.cs @@ -65,41 +65,41 @@ public interface IWritableImage : IMediaImage, IBaseWritableImage /// Writes a sector to the image /// Sector data /// Sector address - /// - /// + /// If the sector address is a negative LBA. + /// The status of the sector. /// true if operating completed successfully, false otherwise bool WriteSector(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus); /// Writes a sector to the image with main channel tags attached /// Sector data with its main channel tags attached /// Sector address - /// - /// + /// If the sector address is a negative LBA. + /// The status of the sector. /// true if operating completed successfully, false otherwise bool WriteSectorLong(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus); /// Writes several sectors to the image /// Sectors data /// Sector starting address - /// + /// If the sector address is a negative LBA. /// How many sectors to write - /// + /// The status of each sector. /// true if operating completed successfully, false otherwise bool WriteSectors(byte[] data, ulong sectorAddress, bool negative, uint length, SectorStatus[] sectorStatus); /// Writes several sectors to the image /// Sector data with their main channel tags attached /// Sector starting address - /// + /// If the sector address is a negative LBA. /// How many sectors to write - /// + /// The status of each sector. /// true if operating completed successfully, false otherwise bool WriteSectorsLong(byte[] data, ulong sectorAddress, bool negative, uint length, SectorStatus[] sectorStatus); /// Writes parallel or subchannel sector tag for several sector /// Tag data to write /// Starting sector address - /// + /// If the sector address is a negative LBA. /// How many sectors to write /// Tag type /// true if operating completed successfully, false otherwise @@ -108,7 +108,7 @@ public interface IWritableImage : IMediaImage, IBaseWritableImage /// Writes parallel or subchannel sector tag for one sector /// Tag data to write /// Sector address - /// + /// If the sector address is a negative LBA. /// Tag type /// true if operating completed successfully, false otherwise bool WriteSectorTag(byte[] data, ulong sectorAddress, bool negative, SectorTagType tag);