VirtualBox

Changeset 64272 in vbox for trunk/include


Ignore:
Timestamp:
Oct 14, 2016 8:25:05 AM (8 years ago)
Author:
vboxsync
Message:

Storage: Doxygen fixes

Location:
trunk/include/VBox
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/vd-cache-backend.h

    r63912 r64272  
    125125     * @param   pBackendData    Opaque state data for this image.
    126126     * @param   uOffset         The offset of the virtual disk to read from.
    127      * @param   cbRead          How many bytes to read.
     127     * @param   cbToRead        How many bytes to read.
    128128     * @param   pIoCtx          I/O context associated with this request.
    129129     * @param   pcbActuallyRead Pointer to returned number of bytes read.
    130130     */
    131     DECLR3CALLBACKMEMBER(int, pfnRead, (void *pBackendData, uint64_t uOffset, size_t cbRead,
     131    DECLR3CALLBACKMEMBER(int, pfnRead, (void *pBackendData, uint64_t uOffset, size_t cbToRead,
    132132                                        PVDIOCTX pIoCtx, size_t *pcbActuallyRead));
    133133
    … …  
    138138     * @param   pBackendData    Opaque state data for this image.
    139139     * @param   uOffset         The offset of the virtual disk to write to.
    140      * @param   cbWrite         How many bytes to write.
     140     * @param   cbToWrite       How many bytes to write.
    141141     * @param   pIoCtx          I/O context associated with this request.
    142142     * @param   pcbWriteProcess Pointer to returned number of bytes that could
    … …  
    147147     *                          amount of (previously read) padding data.
    148148     */
    149     DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pBackendData, uint64_t uOffset, size_t cbWrite,
     149    DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pBackendData, uint64_t uOffset, size_t cbToWrite,
    150150                                         PVDIOCTX pIoCtx, size_t *pcbWriteProcess));
    151151

  • trunk/include/VBox/vd-ifs.h

    r63912 r64272  
    357357     *                          VDAsyncRead or VDAsyncWrite) in pvCompletion
    358358     *                          if this is NULL.
    359      * @param   ppStorage       Where to store the opaque storage handle.
     359     * @param   ppvStorage      Where to store the opaque storage handle.
    360360     */
    361361    DECLR3CALLBACKMEMBER(int, pfnOpen, (void *pvUser, const char *pszLocation,
    362362                                        uint32_t fOpen,
    363363                                        PFNVDCOMPLETED pfnCompleted,
    364                                         void **ppStorage));
     364                                        void **ppvStorage));
    365365
    366366    /**
    … …  
    369369     * @return  VBox status code.
    370370     * @param   pvUser          The opaque data passed on container creation.
    371      * @param   pStorage        The opaque storage handle to close.
    372      */
    373     DECLR3CALLBACKMEMBER(int, pfnClose, (void *pvUser, void *pStorage));
     371     * @param   pvStorage       The opaque storage handle to close.
     372     */
     373    DECLR3CALLBACKMEMBER(int, pfnClose, (void *pvUser, void *pvStorage));
    374374
    375375    /**
    … …  
    419419     * @return  VBox status code.
    420420     * @param   pvUser          The opaque data passed on container creation.
    421      * @param   pStorage        The opaque storage handle to close.
    422      * @param   pcbSize         Where to store the size of the storage backend.
    423      */
    424     DECLR3CALLBACKMEMBER(int, pfnGetSize, (void *pvUser, void *pStorage, uint64_t *pcbSize));
     421     * @param   pvStorage       The opaque storage handle to get the size from.
     422     * @param   pcb             Where to store the size of the storage backend.
     423     */
     424    DECLR3CALLBACKMEMBER(int, pfnGetSize, (void *pvUser, void *pvStorage, uint64_t *pcb));
    425425
    426426    /**
    … …  
    430430     * @retval  VERR_NOT_SUPPORTED if the backend does not support this operation.
    431431     * @param   pvUser          The opaque data passed on container creation.
    432      * @param   pStorage        The opaque storage handle to close.
    433      * @param   cbSize          The new size of the image.
     432     * @param   pvStorage       The opaque storage handle to set the size for.
     433     * @param   cb              The new size of the image.
    434434     *
    435435     * @note Depending on the host the underlying storage (backing file, etc.)
    … …  
    441441     *       really alloacted.
    442442     */
    443     DECLR3CALLBACKMEMBER(int, pfnSetSize, (void *pvUser, void *pStorage, uint64_t cbSize));
     443    DECLR3CALLBACKMEMBER(int, pfnSetSize, (void *pvUser, void *pvStorage, uint64_t cb));
    444444
    445445    /**
    … …  
    451451     *         this method.
    452452     * @param  pvUser          The opaque data passed on container creation.
    453      * @param  pStorage        The storage handle.
     453     * @param  pvStorage       The storage handle.
    454454     * @param  cbSize          The new size of the image.
    455455     * @param  fFlags          Flags for controlling the allocation strategy.
    456456     *                         Reserved for future use, MBZ.
    457457     */
    458     DECLR3CALLBACKMEMBER(int, pfnSetAllocationSize, (void *pvUser, void *pStorage,
     458    DECLR3CALLBACKMEMBER(int, pfnSetAllocationSize, (void *pvUser, void *pvStorage,
    459459                                                     uint64_t cbSize, uint32_t fFlags));
    460460
    … …  
    464464     * @return  VBox status code.
    465465     * @param   pvUser          The opaque data passed on container creation.
    466      * @param   pStorage        The storage handle to use.
    467      * @param   uOffset         The offset to start from.
    468      * @param   pvBuffer        Pointer to the bits need to be written.
    469      * @param   cbBuffer        How many bytes to write.
     466     * @param   pvStorage       The storage handle to use.
     467     * @param   off             The offset to start from.
     468     * @param   pvBuf           Pointer to the bits need to be written.
     469     * @param   cbToWrite       How many bytes to write.
    470470     * @param   pcbWritten      Where to store how many bytes were actually written.
    471471     */
    472     DECLR3CALLBACKMEMBER(int, pfnWriteSync, (void *pvUser, void *pStorage, uint64_t uOffset,
    473                                              const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten));
     472    DECLR3CALLBACKMEMBER(int, pfnWriteSync, (void *pvUser, void *pvStorage, uint64_t off,
     473                                             const void *pvBuf, size_t cbToWrite, size_t *pcbWritten));
    474474
    475475    /**
    … …  
    478478     * @return  VBox status code.
    479479     * @param   pvUser          The opaque data passed on container creation.
    480      * @param   pStorage        The storage handle to use.
    481      * @param   uOffset         The offset to start from.
    482      * @param   pvBuffer        Where to store the read bits.
    483      * @param   cbBuffer        How many bytes to read.
     480     * @param   pvStorage       The storage handle to use.
     481     * @param   off             The offset to start from.
     482     * @param   pvBuf           Where to store the read bits.
     483     * @param   cbToRead        How many bytes to read.
    484484     * @param   pcbRead         Where to store how many bytes were actually read.
    485485     */
    486     DECLR3CALLBACKMEMBER(int, pfnReadSync, (void *pvUser, void *pStorage, uint64_t uOffset,
    487                                             void *pvBuffer, size_t cbBuffer, size_t *pcbRead));
     486    DECLR3CALLBACKMEMBER(int, pfnReadSync, (void *pvUser, void *pvStorage, uint64_t off,
     487                                            void *pvBuf, size_t cbToRead, size_t *pcbRead));
    488488
    489489    /**
    … …  
    492492     * @return  VBox status code.
    493493     * @param   pvUser          The opaque data passed on container creation.
    494      * @param   pStorage        The storage handle to flush.
    495      */
    496     DECLR3CALLBACKMEMBER(int, pfnFlushSync, (void *pvUser, void *pStorage));
     494     * @param   pvStorage       The storage handle to flush.
     495     */
     496    DECLR3CALLBACKMEMBER(int, pfnFlushSync, (void *pvUser, void *pvStorage));
    497497
    498498    /**
    … …  
    501501     * @return  VBox status code.
    502502     * @param   pvUser         The opaque user data passed on container creation.
    503      * @param   pStorage       The storage handle.
     503     * @param   pvStorage      The storage handle.
    504504     * @param   uOffset        The offset to start reading from.
    505505     * @param   paSegments     Scatter gather list to store the data in.
    … …  
    509509     * @param   ppTask         Where to store the opaque task handle.
    510510     */
    511     DECLR3CALLBACKMEMBER(int, pfnReadAsync, (void *pvUser, void *pStorage, uint64_t uOffset,
     511    DECLR3CALLBACKMEMBER(int, pfnReadAsync, (void *pvUser, void *pvStorage, uint64_t uOffset,
    512512                                             PCRTSGSEG paSegments, size_t cSegments,
    513513                                             size_t cbRead, void *pvCompletion,
    … …  
    519519     * @return  VBox status code.
    520520     * @param   pvUser         The opaque user data passed on conatiner creation.
    521      * @param   pStorage       The storage handle.
     521     * @param   pvStorage      The storage handle.
    522522     * @param   uOffset        The offset to start writing to.
    523523     * @param   paSegments     Scatter gather list of the data to write
    … …  
    527527     * @param   ppTask         Where to store the opaque task handle.
    528528     */
    529     DECLR3CALLBACKMEMBER(int, pfnWriteAsync, (void *pvUser, void *pStorage, uint64_t uOffset,
     529    DECLR3CALLBACKMEMBER(int, pfnWriteAsync, (void *pvUser, void *pvStorage, uint64_t uOffset,
    530530                                              PCRTSGSEG paSegments, size_t cSegments,
    531531                                              size_t cbWrite, void *pvCompletion,
    … …  
    537537     * @return  VBox status code.
    538538     * @param   pvUser          The opaque data passed on container creation.
    539      * @param   pStorage        The storage handle to flush.
     539     * @param   pvStorage       The storage handle to flush.
    540540     * @param   pvCompletion    The opaque user data which is returned upon completion.
    541541     * @param   ppTask          Where to store the opaque task handle.
    542542     */
    543     DECLR3CALLBACKMEMBER(int, pfnFlushAsync, (void *pvUser, void *pStorage,
     543    DECLR3CALLBACKMEMBER(int, pfnFlushAsync, (void *pvUser, void *pvStorage,
    544544                                              void *pvCompletion, void **ppTask));
    545545

  • trunk/include/VBox/vd-image-backend.h

    r63912 r64272  
    177177     * @param   pBackendData    Opaque state data for this image.
    178178     * @param   uOffset         The offset of the virtual disk to read from.
    179      * @param   cbRead          How many bytes to read.
     179     * @param   cbToRead        How many bytes to read.
    180180     * @param   pIoCtx          I/O context associated with this request.
    181181     * @param   pcbActuallyRead Pointer to returned number of bytes read.
    182182     */
    183     DECLR3CALLBACKMEMBER(int, pfnRead, (void *pBackendData, uint64_t uOffset, size_t cbRead,
     183    DECLR3CALLBACKMEMBER(int, pfnRead, (void *pBackendData, uint64_t uOffset, size_t cbToRead,
    184184                                        PVDIOCTX pIoCtx, size_t *pcbActuallyRead));
    185185
    … …  
    190190     * @param   pBackendData    Opaque state data for this image.
    191191     * @param   uOffset         The offset of the virtual disk to write to.
    192      * @param   cbWrite         How many bytes to write.
     192     * @param   cbToWrite       How many bytes to write.
    193193     * @param   pIoCtx          I/O context associated with this request.
    194194     * @param   pcbWriteProcess Pointer to returned number of bytes that could
    … …  
    205205     *                          of the VD_WRITE_* flags.
    206206     */
    207     DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pBackendData, uint64_t uOffset, size_t cbWrite,
     207    DECLR3CALLBACKMEMBER(int, pfnWrite, (void *pBackendData, uint64_t uOffset, size_t cbToWrite,
    208208                                         PVDIOCTX pIoCtx,
    209209                                         size_t *pcbWriteProcess, size_t *pcbPreRead,
    … …  
    480480     *
    481481     * @returns VBox status code.
    482      * @param   pBackendData      Opaque state data for this image.
    483      * @param   pszParentFilename Where to store the path.
     482     * @param   pBackendData       Opaque state data for this image.
     483     * @param   ppszParentFilename Where to store the path.
    484484     */
    485485    DECLR3CALLBACKMEMBER(int, pfnGetParentFilename, (void *pBackendData, char **ppszParentFilename));

  • trunk/include/VBox/vd.h

    r60608 r64272  
    10021002 *
    10031003 * @return  VBox status code.
    1004  * @return  VERR_VD_NOT_OPENED if no image is opened in HDD container.
    1005  * @param   pDisk           Pointer to HDD container.
    1006  * @param   off             Offset of first reading byte from start of disk.
     1004 * @retval  VERR_VD_NOT_OPENED if no image is opened in HDD container.
     1005 * @param   pDisk           Pointer to HDD container.
     1006 * @param   uOffset         Offset of first reading byte from start of disk.
    10071007 *                          Must be aligned to a sector boundary.
    1008  * @param   pvBuffer        Pointer to buffer for reading data.
    1009  * @param   cbBuffer        Number of bytes to read.
     1008 * @param   pvBuf           Pointer to buffer for reading data.
     1009 * @param   cbRead          Number of bytes to read.
    10101010 *                          Must be aligned to a sector boundary.
    10111011 */
    1012 VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t off, void *pvBuffer, size_t cbBuffer);
     1012VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuf, size_t cbRead);
    10131013
    10141014/**
    … …  
    10161016 *
    10171017 * @return  VBox status code.
    1018  * @return  VERR_VD_NOT_OPENED if no image is opened in HDD container.
    1019  * @param   pDisk           Pointer to HDD container.
    1020  * @param   off             Offset of first writing byte from start of disk.
     1018 * @retval  VERR_VD_NOT_OPENED if no image is opened in HDD container.
     1019 * @param   pDisk           Pointer to HDD container.
     1020 * @param   uOffset         Offset of first writing byte from start of disk.
    10211021 *                          Must be aligned to a sector boundary.
    1022  * @param   pvBuffer        Pointer to buffer for writing data.
    1023  * @param   cbBuffer        Number of bytes to write.
     1022 * @param   pvBuf           Pointer to buffer for writing data.
     1023 * @param   cbWrite         Number of bytes to write.
    10241024 *                          Must be aligned to a sector boundary.
    10251025 */
    1026 VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t off, const void *pvBuffer, size_t cbBuffer);
     1026VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuf, size_t cbWrite);
    10271027
    10281028/**
    … …  
    10301030 *
    10311031 * @return  VBox status code.
    1032  * @return  VERR_VD_NOT_OPENED if no image is opened in HDD container.
     1032 * @retval  VERR_VD_NOT_OPENED if no image is opened in HDD container.
    10331033 * @param   pDisk           Pointer to HDD container.
    10341034 */
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette