VirtualBox

Changeset 13734 in vbox


Ignore:
Timestamp:
Nov 2, 2008 4:47:46 PM (16 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
38705
Message:

Document alignment restrictions for offset and size parameters in the interface and VBoxHDD-new API

Location:
trunk/include/VBox
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/VBoxHDD-new.h

    r11484 r13734  
    11621162 * @param   pDisk           Pointer to HDD container.
    11631163 * @param   uOffset         Offset of first reading byte from start of disk.
     1164 *                          Must be aligned to a sector boundary.
    11641165 * @param   pvBuf           Pointer to buffer for reading data.
    11651166 * @param   cbRead          Number of bytes to read.
     1167 *                          Must be aligned to a sector boundary.
    11661168 */
    11671169VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuf, size_t cbRead);
    … …  
    11741176 * @param   pDisk           Pointer to HDD container.
    11751177 * @param   uOffset         Offset of first writing byte from start of disk.
     1178 *                          Must be aligned to a sector boundary.
    11761179 * @param   pvBuf           Pointer to buffer for writing data.
    11771180 * @param   cbWrite         Number of bytes to write.
     1181 *                          Must be aligned to a sector boundary.
    11781182 */
    11791183VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuf, size_t cbWrite);

  • trunk/include/VBox/pdmifs.h

    r13079 r13734  
    601601     * @returns VBox status code.
    602602     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    603      * @param   off             Offset to start reading from.
     603     * @param   off             Offset to start reading from. The offset must be aligned to a sector boundary.
    604604     * @param   pvBuf           Where to store the read bits.
    605      * @param   cbRead          Number of bytes to read.
     605     * @param   cbRead          Number of bytes to read. Must be aligned to a sector boundary.
    606606     * @thread  Any thread.
    607607     */
    … …  
    613613     * @returns VBox status code.
    614614     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    615      * @param   off             Offset to start writing at.
     615     * @param   off             Offset to start writing at. The offset must be aligned to a sector boundary.
    616616     * @param   pvBuf           Where to store the write bits.
    617      * @param   cbWrite         Number of bytes to write.
     617     * @param   cbWrite         Number of bytes to write. Must be aligned to a sector boundary.
    618618     * @thread  Any thread.
    619619     */
    … …  
    816816     * @returns VBox status code.
    817817     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    818      * @param   off             Offset to start reading from.
     818     * @param   off             Offset to start reading from. The offset must be aligned to a sector boundary.
    819819     * @param   pvBuf           Where to store the read bits.
    820      * @param   cbRead          Number of bytes to read.
     820     * @param   cbRead          Number of bytes to read. Must be aligned to a sector boundary.
    821821     * @thread  Any thread.
    822822     */
    … …  
    828828     * @returns VBox status code.
    829829     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    830      * @param   off             Offset to start writing at.
     830     * @param   off             Offset to start writing at. The offset must be aligned to a sector boundary.
    831831     * @param   pvBuf           Where to store the write bits.
    832      * @param   cbWrite         Number of bytes to write.
     832     * @param   cbWrite         Number of bytes to write. Must be aligned to a sector boundary.
    833833     * @thread  Any thread.
    834834     */
    … …  
    12201220     * @returns VBox status code.
    12211221     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    1222      * @param   off             Offset to start reading from.
     1222     * @param   off             Offset to start reading from.c
    12231223     * @param   pSeg            Pointer to the first element in the scatter list.
    12241224     * @param   cSeg            Number of entries in the list.
    1225      * @param   cbRead          Number of bytes to read.
     1225     * @param   cbRead          Number of bytes to read. Must be aligned to a sector boundary.
    12261226     * @param   pvUser          User argument which is returned in completion callback.
    12271227     * @thread  Any thread.
    … …  
    12341234     * @returns VBox status code.
    12351235     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    1236      * @param   off             Offset to start writing at.
     1236     * @param   off             Offset to start writing at. The offset must be aligned to a sector boundary.
    12371237     * @param   pSeg            Pointer to the first element in the gather list.
    12381238     * @param   cSeg            Number of entries in the list.
    1239      * @param   cbWrite         Number of bytes to write.
     1239     * @param   cbWrite         Number of bytes to write. Must be aligned to a sector boundary.
    12401240     * @param   pvUser          User argument which is returned in completion callback.
    12411241     * @thread  Any thread.
    … …  
    12791279     * @returns VBox status code.
    12801280     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    1281      * @param   off             Offset to start reading from.
     1281     * @param   off             Offset to start reading from. Must be aligned to a sector boundary.
    12821282     * @param   pSeg            Pointer to the first element in the scatter list.
    12831283     * @param   cSeg            Number of entries in the list.
    1284      * @param   cbRead          Number of bytes to read.
     1284     * @param   cbRead          Number of bytes to read. Must be aligned to a sector boundary.
    12851285     * @param   pvUser          User data.
    12861286     * @thread  Any thread.
    … …  
    12931293     * @returns VBox status code.
    12941294     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
    1295      * @param   off             Offset to start writing at.
     1295     * @param   off             Offset to start writing at. Must be aligned to a sector boundary.
    12961296     * @param   pSeg            Pointer to the first element in the gather list.
    12971297     * @param   cSeg            Number of entries in the list.
    1298      * @param   cbWrite         Number of bytes to write.
     1298     * @param   cbWrite         Number of bytes to write. Must be aligned to a sector boundary.
    12991299     * @param   pvUser          User data.
    13001300     * @thread  Any thread.
Note: See TracChangeset for help on using the changeset viewer.

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