Fix wrong error codes in doxygen documentation.

This commit is contained in:
2025-10-21 14:23:03 +01:00
parent 4a7547705d
commit f53092c941
4 changed files with 35 additions and 35 deletions

View File

@@ -543,11 +543,11 @@ static int32_t write_single_level_ddt(aaruformat_context *ctx)
* - ctx->is_tape is false * - ctx->is_tape is false
* - This function was called for a disk/optical image instead of tape * - This function was called for a disk/optical image instead of tape
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-6) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - calloc() fails to allocate the userDataDdtBig array * - calloc() fails to allocate the userDataDdtBig array
* - Insufficient system memory for (max_key + 1) * 4 bytes * - Insufficient system memory for (max_key + 1) * 4 bytes
* *
* @retval AARUF_ERROR_CANNOT_WRITE_HEADER (-8) Writing the DDT failed. This can occur when: * @retval AARUF_ERROR_CANNOT_WRITE_HEADER (-21) Writing the DDT failed. This can occur when:
* - write_single_level_ddt() fails to write the DDT header * - write_single_level_ddt() fails to write the DDT header
* - File I/O errors prevent writing the DDT data * - File I/O errors prevent writing the DDT data
* - Disk full or other storage errors * - Disk full or other storage errors

View File

@@ -51,7 +51,7 @@
* - The context magic number doesn't match AARU_MAGIC (invalid context type) * - The context magic number doesn't match AARU_MAGIC (invalid context type)
* - The context was not properly initialized by aaruf_open() or aaruf_create() * - The context was not properly initialized by aaruf_open() or aaruf_create()
* *
* @retval AARUF_ERROR_CANNOT_READ_BLOCK (-6) The geometry block is not present. This occurs when: * @retval AARUF_ERROR_CANNOT_READ_BLOCK (-7) The geometry block is not present. This occurs when:
* - The image was created without geometry information * - The image was created without geometry information
* - The geometryBlock.identifier field doesn't equal GeometryBlock * - The geometryBlock.identifier field doesn't equal GeometryBlock
* - The geometry block was not found during image opening * - The geometry block was not found during image opening
@@ -438,7 +438,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_sequence(void *context, const int3
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the creator string * - malloc() failed to allocate the required memory for the creator string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -579,7 +579,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_creator(void *context, const uint8_t *da
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the comments string * - malloc() failed to allocate the required memory for the comments string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -692,7 +692,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_comments(void *context, const uint8_t *d
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media title string * - malloc() failed to allocate the required memory for the media title string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -805,7 +805,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_title(void *context, const uint8_t
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media manufacturer string * - malloc() failed to allocate the required memory for the media manufacturer string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -918,7 +918,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_manufacturer(void *context, const
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media model string * - malloc() failed to allocate the required memory for the media model string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1025,7 +1025,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_model(void *context, const uint8_t
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media serial number string * - malloc() failed to allocate the required memory for the media serial number string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1140,7 +1140,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_serial_number(void *context, const
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media barcode string * - malloc() failed to allocate the required memory for the media barcode string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1263,7 +1263,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_barcode(void *context, const uint8
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the media part number string * - malloc() failed to allocate the required memory for the media part number string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1383,7 +1383,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_media_part_number(void *context, const u
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the drive manufacturer string * - malloc() failed to allocate the required memory for the drive manufacturer string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1499,7 +1499,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_manufacturer(void *context, const
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the drive model string * - malloc() failed to allocate the required memory for the drive model string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1621,7 +1621,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_model(void *context, const uint8_t
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the drive serial number string * - malloc() failed to allocate the required memory for the drive serial number string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1746,7 +1746,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_serial_number(void *context, const
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the drive firmware revision string * - malloc() failed to allocate the required memory for the drive firmware revision string
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large
@@ -1888,7 +1888,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_firmware_revision(void *context, c
* - The context magic number doesn't match AARU_MAGIC (invalid context type) * - The context magic number doesn't match AARU_MAGIC (invalid context type)
* - The context was not properly initialized by aaruf_open() or aaruf_create() * - The context was not properly initialized by aaruf_open() or aaruf_create()
* *
* @retval AARUF_ERROR_CANNOT_READ_BLOCK (-6) The CICM block is not present. This occurs when: * @retval AARUF_ERROR_CANNOT_READ_BLOCK (-7) The CICM block is not present. This occurs when:
* - The image was created without CICM XML metadata * - The image was created without CICM XML metadata
* - ctx->cicmBlock is NULL (no data loaded) * - ctx->cicmBlock is NULL (no data loaded)
* - ctx->cicmBlockHeader.length is 0 (empty metadata) * - ctx->cicmBlockHeader.length is 0 (empty metadata)
@@ -2035,7 +2035,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_get_cicm_metadata(const void *context, uint8
* - The context magic number doesn't match AARU_MAGIC (invalid context type) * - The context magic number doesn't match AARU_MAGIC (invalid context type)
* - The context was not properly initialized by aaruf_open() or aaruf_create() * - The context was not properly initialized by aaruf_open() or aaruf_create()
* *
* @retval AARUF_ERROR_CANNOT_READ_BLOCK (-6) The Aaru JSON block is not present. This occurs when: * @retval AARUF_ERROR_CANNOT_READ_BLOCK (-7) The Aaru JSON block is not present. This occurs when:
* - The image was created without Aaru metadata JSON * - The image was created without Aaru metadata JSON
* - ctx->jsonBlock is NULL (no data loaded) * - ctx->jsonBlock is NULL (no data loaded)
* - ctx->jsonBlockHeader.length is 0 (empty metadata) * - ctx->jsonBlockHeader.length is 0 (empty metadata)
@@ -2194,7 +2194,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_get_aaru_json_metadata(const void *context,
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - malloc() failed to allocate the required memory for the JSON data * - malloc() failed to allocate the required memory for the JSON data
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - The requested allocation size is too large * - The requested allocation size is too large

View File

@@ -178,7 +178,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_read_media_tag(void *context, uint8_t *data,
* - The context parameter is NULL * - The context parameter is NULL
* - The context magic number doesn't match AARU_MAGIC (invalid context type) * - The context magic number doesn't match AARU_MAGIC (invalid context type)
* *
* @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-8) The sector address exceeds image bounds. This occurs when: * @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-5) The sector address exceeds image bounds. This occurs when:
* - sector_address is greater than or equal to ctx->imageInfo.Sectors * - sector_address is greater than or equal to ctx->imageInfo.Sectors
* - Attempting to read beyond the logical extent of the imaged medium * - Attempting to read beyond the logical extent of the imaged medium
* *
@@ -210,7 +210,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_read_media_tag(void *context, uint8_t *data,
* - Decompressed data size doesn't match the expected block length * - Decompressed data size doesn't match the expected block length
* - Compression algorithm encounters corrupted or invalid compressed data * - Compression algorithm encounters corrupted or invalid compressed data
* *
* @retval AARUF_ERROR_UNSUPPORTED_COMPRESSION (-13) Unsupported compression algorithm. This occurs when: * @retval AARUF_ERROR_UNSUPPORTED_COMPRESSION (-8) Unsupported compression algorithm. This occurs when:
* - The block header specifies a compression type not supported by this library * - The block header specifies a compression type not supported by this library
* - Future compression algorithms not implemented in this version * - Future compression algorithms not implemented in this version
* *
@@ -628,20 +628,20 @@ AARU_EXPORT int32_t AARU_CALL aaruf_read_sector(void *context, const uint64_t se
* - ctx->imageInfo.XmlMediaType is not OpticalDisc * - ctx->imageInfo.XmlMediaType is not OpticalDisc
* - This function is only applicable to CD, DVD, BD, and other optical disc formats * - This function is only applicable to CD, DVD, BD, and other optical disc formats
* *
* @retval AARUF_ERROR_TRACK_NOT_FOUND (-12) The specified track does not exist. This occurs when: * @retval AARUF_ERROR_TRACK_NOT_FOUND (-13) The specified track does not exist. This occurs when:
* - No track in ctx->dataTracks[] has a sequence number matching the requested track * - No track in ctx->dataTracks[] has a sequence number matching the requested track
* - The track may not contain data or may not have been imaged * - The track may not contain data or may not have been imaged
* - Only data tracks are searched; audio-only tracks are not included * - Only data tracks are searched; audio-only tracks are not included
* *
* @retval All other error codes from aaruf_read_sector() may be returned: * @retval All other error codes from aaruf_read_sector() may be returned:
* - AARUF_STATUS_SECTOR_NOT_DUMPED (1) - Sector was not dumped during imaging * - AARUF_STATUS_SECTOR_NOT_DUMPED (1) - Sector was not dumped during imaging
* - AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-8) - Calculated absolute sector address exceeds image bounds * - AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-5) - Calculated absolute sector address exceeds image bounds
* - AARUF_ERROR_BUFFER_TOO_SMALL (-10) - Data buffer is NULL or insufficient size * - AARUF_ERROR_BUFFER_TOO_SMALL (-10) - Data buffer is NULL or insufficient size
* - AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) - Memory allocation fails during sector reading * - AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) - Memory allocation fails during sector reading
* - AARUF_ERROR_CANNOT_READ_HEADER (-6) - Block header cannot be read from image stream * - AARUF_ERROR_CANNOT_READ_HEADER (-6) - Block header cannot be read from image stream
* - AARUF_ERROR_CANNOT_READ_BLOCK (-7) - Block data cannot be read from image stream * - AARUF_ERROR_CANNOT_READ_BLOCK (-7) - Block data cannot be read from image stream
* - AARUF_ERROR_CANNOT_DECOMPRESS_BLOCK (-17) - LZMA or FLAC decompression fails * - AARUF_ERROR_CANNOT_DECOMPRESS_BLOCK (-17) - LZMA or FLAC decompression fails
* - AARUF_ERROR_UNSUPPORTED_COMPRESSION (-13) - Block uses unsupported compression * - AARUF_ERROR_UNSUPPORTED_COMPRESSION (-8) - Block uses unsupported compression
* *
* @note Track-Relative Addressing: * @note Track-Relative Addressing:
* - The sector_address parameter is relative to the start of the specified track * - The sector_address parameter is relative to the start of the specified track
@@ -772,7 +772,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_read_track_sector(void *context, uint8_t *da
* - Cannot allocate memory for user data during block media processing * - Cannot allocate memory for user data during block media processing
* - Memory allocation fails in underlying aaruf_read_sector() calls * - Memory allocation fails in underlying aaruf_read_sector() calls
* *
* @retval AARUF_ERROR_TRACK_NOT_FOUND (-12) Cannot locate the sector's track. This occurs when: * @retval AARUF_ERROR_TRACK_NOT_FOUND (-13) Cannot locate the sector's track. This occurs when:
* - For optical discs: the sector address doesn't fall within any data track boundaries * - For optical discs: the sector address doesn't fall within any data track boundaries
* - No track contains the specified sector address (address not in any track.start to track.end range) * - No track contains the specified sector address (address not in any track.start to track.end range)
* - The track list is empty or corrupted * - The track list is empty or corrupted
@@ -787,11 +787,11 @@ AARU_EXPORT int32_t AARU_CALL aaruf_read_track_sector(void *context, uint8_t *da
* - Indicates potential image corruption or library bug * - Indicates potential image corruption or library bug
* *
* @retval All error codes from aaruf_read_sector() may be propagated: * @retval All error codes from aaruf_read_sector() may be propagated:
* - AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-8) - Calculated sector address exceeds image bounds * - AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-5) - Calculated sector address exceeds image bounds
* - AARUF_ERROR_CANNOT_READ_HEADER (-6) - Block header cannot be read * - AARUF_ERROR_CANNOT_READ_HEADER (-6) - Block header cannot be read
* - AARUF_ERROR_CANNOT_READ_BLOCK (-7) - Block data cannot be read * - AARUF_ERROR_CANNOT_READ_BLOCK (-7) - Block data cannot be read
* - AARUF_ERROR_CANNOT_DECOMPRESS_BLOCK (-17) - Decompression fails * - AARUF_ERROR_CANNOT_DECOMPRESS_BLOCK (-17) - Decompression fails
* - AARUF_ERROR_UNSUPPORTED_COMPRESSION (-13) - Compression algorithm not supported * - AARUF_ERROR_UNSUPPORTED_COMPRESSION (-8) - Compression algorithm not supported
* *
* @note Optical Disc Sector Reconstruction: * @note Optical Disc Sector Reconstruction:
* - Creates full 2352-byte sectors from separate user data, sync, header, and ECC/EDC components * - Creates full 2352-byte sectors from separate user data, sync, header, and ECC/EDC components

View File

@@ -464,11 +464,11 @@ AARU_EXPORT int32_t AARU_CALL aaruf_write_sector(void *context, uint64_t sector_
* - Context isWriting flag is false * - Context isWriting flag is false
* - Image was opened without write permissions * - Image was opened without write permissions
* *
* @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-7) Sector address outside valid ranges. This occurs when: * @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-5) Sector address outside valid ranges. This occurs when:
* - negative=true and sector_address >= negative region size * - negative=true and sector_address >= negative region size
* - negative=false and sector_address >= (Sectors + overflow region size) * - negative=false and sector_address >= (Sectors + overflow region size)
* *
* @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-8) Invalid sector size for media type. This occurs when: * @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-26) Invalid sector size for media type. This occurs when:
* - length != 2352 for optical disc media * - length != 2352 for optical disc media
* - length not in {512, 524, 532, 536} for supported block media types * - length not in {512, 524, 532, 536} for supported block media types
* *
@@ -480,7 +480,7 @@ AARU_EXPORT int32_t AARU_CALL aaruf_write_sector(void *context, uint64_t sector_
* - Failed to allocate subchannel buffer (sector_subchannel) * - Failed to allocate subchannel buffer (sector_subchannel)
* - System out of memory during buffer reallocation * - System out of memory during buffer reallocation
* *
* @retval AARUF_ERROR_INCORRECT_MEDIA_TYPE (-26) Unsupported media type for long sectors. This occurs when: * @retval AARUF_ERROR_INCORRECT_MEDIA_TYPE (-12) Unsupported media type for long sectors. This occurs when:
* - Media type is not OpticalDisc or supported BlockMedia variant * - Media type is not OpticalDisc or supported BlockMedia variant
* - Block media type does not support the provided tag format * - Block media type does not support the provided tag format
* *
@@ -1744,7 +1744,7 @@ int32_t aaruf_close_current_block(aaruformat_context *ctx)
* - Image was opened with aaruf_open() instead of aaruf_create() * - Image was opened with aaruf_open() instead of aaruf_create()
* - Context is in read-only mode and modifications are not permitted * - Context is in read-only mode and modifications are not permitted
* *
* @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-8) Invalid data or length parameters. This occurs when: * @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-26) Invalid data or length parameters. This occurs when:
* - data parameter is NULL (no tag data provided) * - data parameter is NULL (no tag data provided)
* - length parameter is zero (no data to write) * - length parameter is zero (no data to write)
* - Parameters indicate invalid or empty tag data * - Parameters indicate invalid or empty tag data
@@ -1985,28 +1985,28 @@ AARU_EXPORT int32_t AARU_CALL aaruf_write_media_tag(void *context, const uint8_t
* - The context's isWriting flag is false * - The context's isWriting flag is false
* - Attempting to modify a read-only image * - Attempting to modify a read-only image
* *
* @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-4) Sector address is invalid. This occurs when: * @retval AARUF_ERROR_SECTOR_OUT_OF_BOUNDS (-5) Sector address is invalid. This occurs when:
* - negative is true and sector_address > negative-1 * - negative is true and sector_address > negative-1
* - negative is false and sector_address > Sectors+overflow-1 * - negative is false and sector_address > Sectors+overflow-1
* - Attempting to write beyond the image boundaries * - Attempting to write beyond the image boundaries
* *
* @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-11) Invalid data or length. This occurs when: * @retval AARUF_ERROR_INCORRECT_DATA_SIZE (-26) Invalid data or length. This occurs when:
* - The data parameter is NULL * - The data parameter is NULL
* - The length parameter is 0 * - The length parameter is 0
* - The length doesn't match the required size for the tag type * - The length doesn't match the required size for the tag type
* - Tag size validation failed * - Tag size validation failed
* *
* @retval AARUF_ERROR_INCORRECT_MEDIA_TYPE (-26) Invalid media type for tag. This occurs when: * @retval AARUF_ERROR_INCORRECT_MEDIA_TYPE (-12) Invalid media type for tag. This occurs when:
* - Attempting to write optical disc tags (CD/DVD) to block media * - Attempting to write optical disc tags (CD/DVD) to block media
* - Attempting to write block media tags to optical disc * - Attempting to write block media tags to optical disc
* - Tag type is incompatible with ctx->imageInfo.XmlMediaType * - Tag type is incompatible with ctx->imageInfo.XmlMediaType
* *
* @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-8) Memory allocation failed. This occurs when: * @retval AARUF_ERROR_NOT_ENOUGH_MEMORY (-9) Memory allocation failed. This occurs when:
* - calloc() failed to allocate buffer for tag data * - calloc() failed to allocate buffer for tag data
* - System is out of memory or memory is severely fragmented * - System is out of memory or memory is severely fragmented
* - Buffer allocation is required but cannot be satisfied * - Buffer allocation is required but cannot be satisfied
* *
* @retval AARUF_ERROR_TRACK_NOT_FOUND (-25) Track not found for sector. This occurs when: * @retval AARUF_ERROR_TRACK_NOT_FOUND (-13) Track not found for sector. This occurs when:
* - Writing CdTrackFlags or CdTrackIsrc tags * - Writing CdTrackFlags or CdTrackIsrc tags
* - The specified sector is not contained within any defined track * - The specified sector is not contained within any defined track
* - Track metadata has not been initialized * - Track metadata has not been initialized