Index: /trunk/src/VBox/Storage/VD.cpp =================================================================== --- /trunk/src/VBox/Storage/VD.cpp (revision 86525) +++ /trunk/src/VBox/Storage/VD.cpp (revision 86526) @@ -5022,9 +5022,5 @@ } -/** - * Initializes HDD backends. - * - * @returns VBox status code. - */ + VBOXDDU_DECL(int) VDInit(void) { @@ -5034,9 +5030,5 @@ } -/** - * Destroys loaded HDD backends. - * - * @returns VBox status code. - */ + VBOXDDU_DECL(int) VDShutdown(void) { @@ -5044,10 +5036,5 @@ } -/** - * Loads a single plugin given by filename. - * - * @returns VBox status code. - * @param pszFilename The plugin filename to load. - */ + VBOXDDU_DECL(int) VDPluginLoadFromFilename(const char *pszFilename) { @@ -5080,10 +5067,5 @@ } -/** - * Unloads a single plugin given by filename. - * - * @returns VBox status code. - * @param pszFilename The plugin filename to unload. - */ + VBOXDDU_DECL(int) VDPluginUnloadFromFilename(const char *pszFilename) { @@ -5098,10 +5080,5 @@ } -/** - * Unload all plugins from a given path. - * - * @returns VBox statuse code. - * @param pszPath The path to unload plugins from. - */ + VBOXDDU_DECL(int) VDPluginUnloadFromPath(const char *pszPath) { @@ -5116,13 +5093,5 @@ } -/** - * Lists all HDD backends and their capabilities in a caller-provided buffer. - * - * @returns VBox status code. - * VERR_BUFFER_OVERFLOW if not enough space is passed. - * @param cEntriesAlloc Number of list entries available. - * @param pEntries Pointer to array for the entries. - * @param pcEntriesUsed Number of entries returned. - */ + VBOXDDU_DECL(int) VDBackendInfo(unsigned cEntriesAlloc, PVDBACKENDINFO pEntries, unsigned *pcEntriesUsed) @@ -5170,11 +5139,5 @@ } -/** - * Lists the capabilities of a backend identified by its name. - * - * @returns VBox status code. - * @param pszBackend The backend name. - * @param pEntry Pointer to an entry. - */ + VBOXDDU_DECL(int) VDBackendInfoOne(const char *pszBackend, PVDBACKENDINFO pEntry) { @@ -5203,13 +5166,5 @@ } -/** - * Lists all filters and their capabilities in a caller-provided buffer. - * - * @return VBox status code. - * VERR_BUFFER_OVERFLOW if not enough space is passed. - * @param cEntriesAlloc Number of list entries available. - * @param pEntries Pointer to array for the entries. - * @param pcEntriesUsed Number of entries returned. - */ + VBOXDDU_DECL(int) VDFilterInfo(unsigned cEntriesAlloc, PVDFILTERINFO pEntries, unsigned *pcEntriesUsed) @@ -5251,11 +5206,5 @@ } -/** - * Lists the capabilities of a filter identified by its name. - * - * @return VBox status code. - * @param pszFilter The filter name (case insensitive). - * @param pEntry Pointer to an entry. - */ + VBOXDDU_DECL(int) VDFilterInfoOne(const char *pszFilter, PVDFILTERINFO pEntry) { @@ -5282,13 +5231,5 @@ } -/** - * Allocates and initializes an empty HDD container. - * No image files are opened. - * - * @returns VBox status code. - * @param pVDIfsDisk Pointer to the per-disk VD interface list. - * @param enmType Type of the image container. - * @param ppDisk Where to store the reference to HDD container. - */ + VBOXDDU_DECL(int) VDCreate(PVDINTERFACE pVDIfsDisk, VDTYPE enmType, PVDISK *ppDisk) { @@ -5367,11 +5308,5 @@ } -/** - * Destroys HDD container. - * If container has opened image files they will be closed. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(int) VDDestroy(PVDISK pDisk) { @@ -5398,19 +5333,5 @@ } -/** - * Try to get the backend name which can use this image. - * - * @returns VBox status code. - * VINF_SUCCESS if a plugin was found. - * ppszFormat contains the string which can be used as backend name. - * VERR_NOT_SUPPORTED if no backend was found. - * @param pVDIfsDisk Pointer to the per-disk VD interface list. - * @param pVDIfsImage Pointer to the per-image VD interface list. - * @param pszFilename Name of the image file for which the backend is queried. - * @param enmDesiredType The desired image type, VDTYPE_INVALID if anything goes. - * @param ppszFormat Receives pointer of the UTF-8 string which contains the format name. - * The returned pointer must be freed using RTStrFree(). - * @param penmType Where to store the type of the image. - */ + VBOXDDU_DECL(int) VDGetFormat(PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage, const char *pszFilename, VDTYPE enmDesiredType, @@ -5567,24 +5488,5 @@ } -/** - * Opens an image file. - * - * The first opened image file in HDD container must have a base image type, - * others (next opened images) must be a differencing or undo images. - * Linkage is checked for differencing image to be in consistence with the previously opened image. - * When another differencing image is opened and the last image was opened in read/write access - * mode, then the last image is reopened in read-only with deny write sharing mode. This allows - * other processes to use images in read-only mode too. - * - * Note that the image is opened in read-only mode if a read/write open is not possible. - * Use VDIsReadOnly to check open mode. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - * @param pszBackend Name of the image file backend to use. - * @param pszFilename Name of the image file to open. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * @param pVDIfsImage Pointer to the per-image VD interface list. - */ + VBOXDDU_DECL(int) VDOpen(PVDISK pDisk, const char *pszBackend, const char *pszFilename, unsigned uOpenFlags, @@ -5905,14 +5807,5 @@ } -/** - * Opens a cache image. - * - * @return VBox status code. - * @param pDisk Pointer to the HDD container which should use the cache image. - * @param pszBackend Name of the cache file backend to use (case insensitive). - * @param pszFilename Name of the cache image to open. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * @param pVDIfsCache Pointer to the per-cache VD interface list. - */ + VBOXDDU_DECL(int) VDCacheOpen(PVDISK pDisk, const char *pszBackend, const char *pszFilename, unsigned uOpenFlags, @@ -6087,4 +5980,5 @@ } + VBOXDDU_DECL(int) VDFilterAdd(PVDISK pDisk, const char *pszFilter, uint32_t fFlags, PVDINTERFACE pVDIfsFilter) @@ -6181,21 +6075,5 @@ } -/** - * Creates and opens a new base image file. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - * @param pszBackend Name of the image file backend to use. - * @param pszFilename Name of the image file to create. - * @param cbSize Image size in bytes. - * @param uImageFlags Flags specifying special image features. - * @param pszComment Pointer to image comment. NULL is ok. - * @param pPCHSGeometry Pointer to physical disk geometry <= (16383,16,63). Not NULL. - * @param pLCHSGeometry Pointer to logical disk geometry <= (x,255,63). Not NULL. - * @param pUuid New UUID of the image. If NULL, a new UUID is created. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * @param pVDIfsImage Pointer to the per-image VD interface list. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ + VBOXDDU_DECL(int) VDCreateBase(PVDISK pDisk, const char *pszBackend, const char *pszFilename, uint64_t cbSize, @@ -6487,20 +6365,5 @@ } -/** - * Creates and opens a new differencing image file in HDD container. - * See comments for VDOpen function about differencing images. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - * @param pszBackend Name of the image file backend to use. - * @param pszFilename Name of the differencing image file to create. - * @param uImageFlags Flags specifying special image features. - * @param pszComment Pointer to image comment. NULL is ok. - * @param pUuid New UUID of the image. If NULL, a new UUID is created. - * @param pParentUuid New parent UUID of the image. If NULL, the UUID is queried automatically. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * @param pVDIfsImage Pointer to the per-image VD interface list. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ + VBOXDDU_DECL(int) VDCreateDiff(PVDISK pDisk, const char *pszBackend, const char *pszFilename, unsigned uImageFlags, @@ -6765,18 +6628,4 @@ -/** - * Creates and opens new cache image file in HDD container. - * - * @return VBox status code. - * @param pDisk Name of the cache file backend to use (case insensitive). - * @param pszFilename Name of the differencing cache file to create. - * @param cbSize Maximum size of the cache. - * @param uImageFlags Flags specifying special cache features. - * @param pszComment Pointer to image comment. NULL is ok. - * @param pUuid New UUID of the image. If NULL, a new UUID is created. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * @param pVDIfsCache Pointer to the per-cache VD interface list. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ VBOXDDU_DECL(int) VDCreateCache(PVDISK pDisk, const char *pszBackend, const char *pszFilename, uint64_t cbSize, @@ -6981,17 +6830,5 @@ } -/** - * Merges two images (not necessarily with direct parent/child relationship). - * As a side effect the source image and potentially the other images which - * are also merged to the destination are deleted from both the disk and the - * images in the HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImageFrom Name of the image file to merge from. - * @param nImageTo Name of the image file to merge to. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ + VBOXDDU_DECL(int) VDMerge(PVDISK pDisk, unsigned nImageFrom, unsigned nImageTo, PVDINTERFACE pVDIfsOperation) @@ -7433,43 +7270,5 @@ } -/** - * Copies an image from one HDD container to another - extended version. - * The copy is opened in the target HDD container. - * It is possible to convert between different image formats, because the - * backend for the destination may be different from the source. - * If both the source and destination reference the same HDD container, - * then the image is moved (by copying/deleting or renaming) to the new location. - * The source container is unchanged if the move operation fails, otherwise - * the image at the new location is opened in the same way as the old one was. - * - * @note The read/write accesses across disks are not synchronized, just the - * accesses to each disk. Once there is a use case which requires a defined - * read/write behavior in this situation this needs to be extended. - * - * @returns VBox status code. - * @retval VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDiskFrom Pointer to source HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pDiskTo Pointer to destination HDD container. - * @param pszBackend Name of the image file backend to use (may be NULL to use the same as the source, case insensitive). - * @param pszFilename New name of the image (may be NULL to specify that the - * copy destination is the destination container, or - * if pDiskFrom == pDiskTo, i.e. when moving). - * @param fMoveByRename If true, attempt to perform a move by renaming (if successful the new size is ignored). - * @param cbSize New image size (0 means leave unchanged). - * @param nImageFromSame todo - * @param nImageToSame todo - * @param uImageFlags Flags specifying special destination image features. - * @param pDstUuid New UUID of the destination image. If NULL, a new UUID is created. - * This parameter is used if and only if a true copy is created. - * In all rename/move cases or copy to existing image cases the modification UUIDs are copied over. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * Only used if the destination image is created. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - * @param pDstVDIfsImage Pointer to the per-image VD interface list, for the - * destination image. - * @param pDstVDIfsOperation Pointer to the per-operation VD interface list, - * for the destination operation. - */ + VBOXDDU_DECL(int) VDCopyEx(PVDISK pDiskFrom, unsigned nImage, PVDISK pDiskTo, const char *pszBackend, const char *pszFilename, @@ -7772,35 +7571,5 @@ } -/** - * Copies an image from one HDD container to another. - * The copy is opened in the target HDD container. - * It is possible to convert between different image formats, because the - * backend for the destination may be different from the source. - * If both the source and destination reference the same HDD container, - * then the image is moved (by copying/deleting or renaming) to the new location. - * The source container is unchanged if the move operation fails, otherwise - * the image at the new location is opened in the same way as the old one was. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDiskFrom Pointer to source HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pDiskTo Pointer to destination HDD container. - * @param pszBackend Name of the image file backend to use. - * @param pszFilename New name of the image (may be NULL if pDiskFrom == pDiskTo). - * @param fMoveByRename If true, attempt to perform a move by renaming (if successful the new size is ignored). - * @param cbSize New image size (0 means leave unchanged). - * @param uImageFlags Flags specifying special destination image features. - * @param pDstUuid New UUID of the destination image. If NULL, a new UUID is created. - * This parameter is used if and only if a true copy is created. - * In all rename/move cases the UUIDs are copied over. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - * Only used if the destination image is created. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - * @param pDstVDIfsImage Pointer to the per-image VD interface list, for the - * destination image. - * @param pDstVDIfsOperation Pointer to the per-image VD interface list, - * for the destination image. - */ + VBOXDDU_DECL(int) VDCopy(PVDISK pDiskFrom, unsigned nImage, PVDISK pDiskTo, const char *pszBackend, const char *pszFilename, @@ -7817,20 +7586,5 @@ } -/** - * Optimizes the storage consumption of an image. Typically the unused blocks - * have to be wiped with zeroes to achieve a substantial reduced storage use. - * Another optimization done is reordering the image blocks, which can provide - * a significant performance boost, as reads and writes tend to use less random - * file offsets. - * - * @return VBox status code. - * @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @return VERR_VD_IMAGE_READ_ONLY if image is not writable. - * @return VERR_NOT_SUPPORTED if this kind of image can be compacted, but - * the code for this isn't implemented yet. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ + VBOXDDU_DECL(int) VDCompact(PVDISK pDisk, unsigned nImage, PVDINTERFACE pVDIfsOperation) @@ -7928,17 +7682,5 @@ } -/** - * Resizes the given disk image to the given size. - * - * @return VBox status - * @return VERR_VD_IMAGE_READ_ONLY if image is not writable. - * @return VERR_NOT_SUPPORTED if this kind of image can be compacted, but - * - * @param pDisk Pointer to the HDD container. - * @param cbSize New size of the image. - * @param pPCHSGeometry Pointer to the new physical disk geometry <= (16383,16,63). Not NULL. - * @param pLCHSGeometry Pointer to the new logical disk geometry <= (x,255,63). Not NULL. - * @param pVDIfsOperation Pointer to the per-operation VD interface list. - */ + VBOXDDU_DECL(int) VDResize(PVDISK pDisk, uint64_t cbSize, PCVDGEOMETRY pPCHSGeometry, @@ -8254,15 +7996,5 @@ } -/** - * Closes the last opened image file in HDD container. - * If previous image file was opened in read-only mode (the normal case) and - * the last opened image is in read-write mode then the previous image will be - * reopened in read/write mode. - * - * @returns VBox status code. - * @returns VERR_VD_NOT_OPENED if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - * @param fDelete If true, delete the image from the host disk. - */ + VBOXDDU_DECL(int) VDClose(PVDISK pDisk, bool fDelete) { @@ -8367,12 +8099,5 @@ } -/** - * Closes the currently opened cache image file in HDD container. - * - * @return VBox status code. - * @return VERR_VD_NOT_OPENED if no cache is opened in HDD container. - * @param pDisk Pointer to HDD container. - * @param fDelete If true, delete the image from the host disk. - */ + VBOXDDU_DECL(int) VDCacheClose(PVDISK pDisk, bool fDelete) { @@ -8467,10 +8192,5 @@ } -/** - * Closes all opened image files in HDD container. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(int) VDCloseAll(PVDISK pDisk) { @@ -8531,10 +8251,5 @@ } -/** - * Removes all filters of the given HDD container. - * - * @return VBox status code. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(int) VDFilterRemoveAll(PVDISK pDisk) { @@ -8581,14 +8296,5 @@ } -/** - * Read data from virtual HDD. - * - * @returns VBox status code. - * @retval VERR_VD_NOT_OPENED if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - * @param uOffset Offset of first reading byte from start of disk. - * @param pvBuf Pointer to buffer for reading data. - * @param cbRead Number of bytes to read. - */ + VBOXDDU_DECL(int) VDRead(PVDISK pDisk, uint64_t uOffset, void *pvBuf, size_t cbRead) @@ -8649,15 +8355,5 @@ } -/** - * Write data to virtual HDD. - * - * @returns VBox status code. - * @retval VERR_VD_NOT_OPENED if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - * @param uOffset Offset of the first byte being - * written from start of disk. - * @param pvBuf Pointer to buffer for writing data. - * @param cbWrite Number of bytes to write. - */ + VBOXDDU_DECL(int) VDWrite(PVDISK pDisk, uint64_t uOffset, const void *pvBuf, size_t cbWrite) @@ -8724,11 +8420,5 @@ } -/** - * Make sure the on disk representation of a virtual HDD is up to date. - * - * @returns VBox status code. - * @retval VERR_VD_NOT_OPENED if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(int) VDFlush(PVDISK pDisk) { @@ -8779,10 +8469,5 @@ } -/** - * Get number of opened images in HDD container. - * - * @returns Number of opened images for HDD container. 0 if no images have been opened. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(unsigned) VDGetCount(PVDISK pDisk) { @@ -8815,11 +8500,5 @@ } -/** - * Get read/write mode of HDD container. - * - * @returns Virtual disk ReadOnly status. - * @returns true if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - */ + VBOXDDU_DECL(bool) VDIsReadOnly(PVDISK pDisk) { @@ -8857,12 +8536,5 @@ } -/** - * Get sector size of an image in HDD container. - * - * @return Virtual disk sector size in bytes. - * @return 0 if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - */ + VBOXDDU_DECL(uint32_t) VDGetSectorSize(PVDISK pDisk, unsigned nImage) { @@ -8909,12 +8581,5 @@ } -/** - * Get total capacity of an image in HDD container. - * - * @returns Virtual disk size in bytes. - * @returns 0 if no image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - */ + VBOXDDU_DECL(uint64_t) VDGetSize(PVDISK pDisk, unsigned nImage) { @@ -8950,12 +8615,5 @@ } -/** - * Get total file size of an image in HDD container. - * - * @returns Virtual disk size in bytes. - * @returns 0 if no image is opened in HDD container. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - */ + VBOXDDU_DECL(uint64_t) VDGetFileSize(PVDISK pDisk, unsigned nImage) { @@ -8990,14 +8648,5 @@ } -/** - * Get virtual disk PCHS geometry stored in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pPCHSGeometry Where to store PCHS geometry. Not NULL. - */ + VBOXDDU_DECL(int) VDGetPCHSGeometry(PVDISK pDisk, unsigned nImage, PVDGEOMETRY pPCHSGeometry) @@ -9052,16 +8701,5 @@ } -/** - * Store virtual disk PCHS geometry in HDD container. - * - * Note that in case of unrecoverable error all images in HDD container will be closed. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pPCHSGeometry Where to load PCHS geometry from. Not NULL. - */ + VBOXDDU_DECL(int) VDSetPCHSGeometry(PVDISK pDisk, unsigned nImage, PCVDGEOMETRY pPCHSGeometry) @@ -9158,14 +8796,5 @@ } -/** - * Get virtual disk LCHS geometry stored in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pLCHSGeometry Where to store LCHS geometry. Not NULL. - */ + VBOXDDU_DECL(int) VDGetLCHSGeometry(PVDISK pDisk, unsigned nImage, PVDGEOMETRY pLCHSGeometry) @@ -9220,16 +8849,5 @@ } -/** - * Store virtual disk LCHS geometry in HDD container. - * - * Note that in case of unrecoverable error all images in HDD container will be closed. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pLCHSGeometry Where to load LCHS geometry from. Not NULL. - */ + VBOXDDU_DECL(int) VDSetLCHSGeometry(PVDISK pDisk, unsigned nImage, PCVDGEOMETRY pLCHSGeometry) @@ -9326,16 +8944,5 @@ } -/** - * Queries the available regions of an image in the given VD container. - * - * @return VBox status code. - * @retval VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @retval VERR_NOT_SUPPORTED if the image backend doesn't support region lists. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param fFlags Combination of VD_REGION_LIST_F_* flags. - * @param ppRegionList Where to store the pointer to the region list on success, must be freed - * with VDRegionListFree(). - */ + VBOXDDU_DECL(int) VDQueryRegions(PVDISK pDisk, unsigned nImage, uint32_t fFlags, PPVDREGIONLIST ppRegionList) @@ -9386,10 +8993,5 @@ } -/** - * Frees a region list previously queried with VDQueryRegions(). - * - * @return nothing. - * @param pRegionList The region list to free. - */ + VBOXDDU_DECL(void) VDRegionListFree(PVDREGIONLIST pRegionList) { @@ -9397,13 +8999,5 @@ } -/** - * Get version of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param puVersion Where to store the image version. - */ + VBOXDDU_DECL(int) VDGetVersion(PVDISK pDisk, unsigned nImage, unsigned *puVersion) @@ -9446,13 +9040,5 @@ } -/** - * List the capabilities of image backend in HDD container. - * - * @returns VBox status code. - * @retval VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to the HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pBackendInfo Where to store the backend information. - */ + VBOXDDU_DECL(int) VDBackendInfoSingle(PVDISK pDisk, unsigned nImage, PVDBACKENDINFO pBackendInfo) @@ -9498,13 +9084,5 @@ } -/** - * Get flags of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param puImageFlags Where to store the image flags. - */ + VBOXDDU_DECL(int) VDGetImageFlags(PVDISK pDisk, unsigned nImage, unsigned *puImageFlags) @@ -9547,13 +9125,5 @@ } -/** - * Get open flags of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param puOpenFlags Where to store the image open flags. - */ + VBOXDDU_DECL(int) VDGetOpenFlags(PVDISK pDisk, unsigned nImage, unsigned *puOpenFlags) @@ -9596,15 +9166,5 @@ } -/** - * Set open flags of image in HDD container. - * This operation may cause file locking changes and/or files being reopened. - * Note that in case of unrecoverable error all images in HDD container will be closed. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants. - */ + VBOXDDU_DECL(int) VDSetOpenFlags(PVDISK pDisk, unsigned nImage, unsigned uOpenFlags) @@ -9654,17 +9214,5 @@ } -/** - * Get base filename of image in HDD container. Some image formats use - * other filenames as well, so don't use this for anything but informational - * purposes. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_BUFFER_OVERFLOW if pszFilename buffer too small to hold filename. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pszFilename Where to store the image file name. - * @param cbFilename Size of buffer pszFilename points to. - */ + VBOXDDU_DECL(int) VDGetFilename(PVDISK pDisk, unsigned nImage, char *pszFilename, unsigned cbFilename) @@ -9721,15 +9269,5 @@ } -/** - * Get the comment line of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @returns VERR_BUFFER_OVERFLOW if pszComment buffer too small to hold comment text. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pszComment Where to store the comment string of image. NULL is ok. - * @param cbComment The size of pszComment buffer. 0 is ok. - */ + VBOXDDU_DECL(int) VDGetComment(PVDISK pDisk, unsigned nImage, char *pszComment, unsigned cbComment) @@ -9776,13 +9314,5 @@ } -/** - * Changes the comment line of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pszComment New comment string (UTF-8). NULL is allowed to reset the comment. - */ + VBOXDDU_DECL(int) VDSetComment(PVDISK pDisk, unsigned nImage, const char *pszComment) @@ -9826,13 +9356,4 @@ -/** - * Get UUID of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid Where to store the image creation UUID. - */ VBOXDDU_DECL(int) VDGetUuid(PVDISK pDisk, unsigned nImage, PRTUUID pUuid) { @@ -9873,13 +9394,5 @@ } -/** - * Set the image's UUID. Should not be used by normal applications. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid New UUID of the image. If NULL, a new UUID is created. - */ + VBOXDDU_DECL(int) VDSetUuid(PVDISK pDisk, unsigned nImage, PCRTUUID pUuid) { @@ -9926,13 +9439,5 @@ } -/** - * Get last modification UUID of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid Where to store the image modification UUID. - */ + VBOXDDU_DECL(int) VDGetModificationUuid(PVDISK pDisk, unsigned nImage, PRTUUID pUuid) { @@ -9974,13 +9479,5 @@ } -/** - * Set the image's last modification UUID. Should not be used by normal applications. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid New modification UUID of the image. If NULL, a new UUID is created. - */ + VBOXDDU_DECL(int) VDSetModificationUuid(PVDISK pDisk, unsigned nImage, PCRTUUID pUuid) { @@ -10029,13 +9526,5 @@ } -/** - * Get parent UUID of image in HDD container. - * - * @returns VBox status code. - * @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid Where to store the parent image UUID. - */ + VBOXDDU_DECL(int) VDGetParentUuid(PVDISK pDisk, unsigned nImage, PRTUUID pUuid) @@ -10077,12 +9566,5 @@ } -/** - * Set the image's parent UUID. Should not be used by normal applications. - * - * @returns VBox status code. - * @param pDisk Pointer to HDD container. - * @param nImage Image number, counts from 0. 0 is always base image of container. - * @param pUuid New parent UUID of the image. If NULL, a new UUID is created. - */ + VBOXDDU_DECL(int) VDSetParentUuid(PVDISK pDisk, unsigned nImage, PCRTUUID pUuid) @@ -10132,9 +9614,4 @@ -/** - * Debug helper - dumps all opened images in HDD container into the log file. - * - * @param pDisk Pointer to HDD container. - */ VBOXDDU_DECL(void) VDDumpImages(PVDISK pDisk) {