VirtualBox

Changeset 34126 in vbox for trunk/include/VBox


Ignore:
Timestamp:
Nov 16, 2010 5:05:54 PM (14 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
67837
Message:

pdmifs.h/PDMIVMMDEVPORT: Brushed up parameter names and docs.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/pdmifs.h

    r33758 r34126  
    19281928     *
    19291929     * @returns VBox status code
    1930      * @param   pAbsX   Pointer of result value, can be NULL
    1931      * @param   pAbsY   Pointer of result value, can be NULL
    1932      */
    1933     DECLR3CALLBACKMEMBER(int, pfnQueryAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t *pAbsX, uint32_t *pAbsY));
     1930     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1931     * @param   pxAbs           Pointer of result value, can be NULL
     1932     * @param   pyAbs           Pointer of result value, can be NULL
     1933     */
     1934    DECLR3CALLBACKMEMBER(int, pfnQueryAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t *pxAbs, uint32_t *pyAbs));
    19341935
    19351936    /**
    … …  
    19371938     *
    19381939     * @returns VBox status code
    1939      * @param   absX   New absolute X position
    1940      * @param   absY   New absolute Y position
    1941      */
    1942     DECLR3CALLBACKMEMBER(int, pfnSetAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t absX, uint32_t absY));
     1940     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1941     * @param   xabs            New absolute X position
     1942     * @param   yAbs            New absolute Y position
     1943     */
     1944    DECLR3CALLBACKMEMBER(int, pfnSetAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t xAbs, uint32_t yAbs));
    19431945
    19441946    /**
    … …  
    19461948     *
    19471949     * @returns VBox status code
    1948      * @param   pCapabilities  Pointer of result value
    1949      */
    1950     DECLR3CALLBACKMEMBER(int, pfnQueryMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t *pCapabilities));
     1950     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1951     * @param   pfCapabilities  Pointer of result value
     1952     */
     1953    DECLR3CALLBACKMEMBER(int, pfnQueryMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t *pfCapabilities));
    19511954
    19521955    /**
    … …  
    19541957     *
    19551958     * @returns VBox status code
    1956      * @param   fCapsAdded    Mask of capabilities to add to the flag
    1957      * @param   fCapsRemoved  Mask of capabilities to remove from the flag
    1958      */
    1959     DECLR3CALLBACKMEMBER(int, pfnUpdateMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t fCapsAdded, uint32_t fCapsremoved));
     1959     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1960     * @param   fCapsAdded      Mask of capabilities to add to the flag
     1961     * @param   fCapsRemoved    Mask of capabilities to remove from the flag
     1962     */
     1963    DECLR3CALLBACKMEMBER(int, pfnUpdateMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t fCapsAdded, uint32_t fCapsRemoved));
    19601964
    19611965    /**
    … …  
    19661970     *
    19671971     * @returns VBox status code
    1968      * @param   cx          Horizontal pixel resolution (0 = do not change).
    1969      * @param   cy          Vertical pixel resolution (0 = do not change).
    1970      * @param   cBits       Bits per pixel (0 = do not change).
    1971      * @param   display     The display index.
    1972      */
    1973     DECLR3CALLBACKMEMBER(int, pfnRequestDisplayChange,(PPDMIVMMDEVPORT pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, uint32_t display));
     1972     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1973     * @param   cx              Horizontal pixel resolution (0 = do not change).
     1974     * @param   cy              Vertical pixel resolution (0 = do not change).
     1975     * @param   cBits           Bits per pixel (0 = do not change).
     1976     * @param   idxDisplay      The display index.
     1977     */
     1978    DECLR3CALLBACKMEMBER(int, pfnRequestDisplayChange,(PPDMIVMMDEVPORT pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, uint32_t idxDisplay));
    19741979
    19751980    /**
    … …  
    19801985     *
    19811986     * @returns VBox status code.
    1982      * @param   pszUsername            User name, may be empty (UTF-8).
    1983      * @param   pszPassword            Password, may be empty (UTF-8).
    1984      * @param   pszDomain              Domain name, may be empty (UTF-8).
    1985      * @param   fFlags                 VMMDEV_SETCREDENTIALS_*.
     1987     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     1988     * @param   pszUsername     User name, may be empty (UTF-8).
     1989     * @param   pszPassword     Password, may be empty (UTF-8).
     1990     * @param   pszDomain       Domain name, may be empty (UTF-8).
     1991     * @param   fFlags          VMMDEV_SETCREDENTIALS_*.
    19861992     */
    19871993    DECLR3CALLBACKMEMBER(int, pfnSetCredentials,(PPDMIVMMDEVPORT pInterface, const char *pszUsername,
    … …  
    19931999     *
    19942000     * @returns Nothing. Because it is informational callback.
    1995      * @param   fEnabled    Current VBVA status.
     2001     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     2002     * @param   fEnabled        Current VBVA status.
    19962003     */
    19972004    DECLR3CALLBACKMEMBER(void, pfnVBVAChange, (PPDMIVMMDEVPORT pInterface, bool fEnabled));
    … …  
    20042011     *
    20052012     * @returns VBox status code
    2006      * @param   fEnabled       Seamless mode enabled or not
     2013     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     2014     * @param   fEnabled        Seamless mode enabled or not
    20072015     */
    20082016    DECLR3CALLBACKMEMBER(int, pfnRequestSeamlessChange,(PPDMIVMMDEVPORT pInterface, bool fEnabled));
    … …  
    20152023     *
    20162024     * @returns VBox status code
    2017      * @param   ulBalloonSize   Balloon size in megabytes
    2018      */
    2019     DECLR3CALLBACKMEMBER(int, pfnSetMemoryBalloon,(PPDMIVMMDEVPORT pInterface, uint32_t ulBalloonSize));
     2025     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     2026     * @param   cMbBalloon      Balloon size in megabytes
     2027     */
     2028    DECLR3CALLBACKMEMBER(int, pfnSetMemoryBalloon,(PPDMIVMMDEVPORT pInterface, uint32_t cMbBalloon));
    20202029
    20212030    /**
    … …  
    20262035     *
    20272036     * @returns VBox status code
    2028      * @param   ulStatInterval  Statistics query interval in seconds (0=disable)
    2029      */
    2030     DECLR3CALLBACKMEMBER(int, pfnSetStatisticsInterval,(PPDMIVMMDEVPORT pInterface, uint32_t ulStatInterval));
     2037     * @param   pInterface          Pointer to the interface structure containing the called function pointer.
     2038     * @param   cSecsStatInterval   Statistics query interval in seconds
     2039     *                              (0=disable).
     2040     */
     2041    DECLR3CALLBACKMEMBER(int, pfnSetStatisticsInterval,(PPDMIVMMDEVPORT pInterface, uint32_t cSecsStatInterval));
    20312042
    20322043    /**
    … …  
    20342045     *
    20352046     * @returns VBox status code
    2036      * @param   fVRDPEnabled           Current VRDP status.
    2037      * @param   u32VRDPExperienceLevel Which visual effects to be disabled in the guest.
    2038      */
    2039     DECLR3CALLBACKMEMBER(int, pfnVRDPChange, (PPDMIVMMDEVPORT pInterface, bool fVRDPEnabled, uint32_t u32VRDPExperienceLevel));
     2047     * @param   pInterface              Pointer to the interface structure containing the called function pointer.
     2048     * @param   fVRDPEnabled            Current VRDP status.
     2049     * @param   uVRDPExperienceLevel    Which visual effects to be disabled in
     2050     *                                  the guest.
     2051     */
     2052    DECLR3CALLBACKMEMBER(int, pfnVRDPChange, (PPDMIVMMDEVPORT pInterface, bool fVRDPEnabled, uint32_t uVRDPExperienceLevel));
    20402053
    20412054    /**
    … …  
    20432056     *
    20442057     * @returns VBox status code
    2045      * @param   idCpuCore    The core id of the CPU to remove.
    2046      * @param   idCpuPackage The package id of the CPU to remove.
     2058     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     2059     * @param   idCpuCore       The core id of the CPU to remove.
     2060     * @param   idCpuPackage    The package id of the CPU to remove.
    20472061     */
    20482062    DECLR3CALLBACKMEMBER(int, pfnCpuHotUnplug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
    … …  
    20522066     *
    20532067     * @returns VBox status code
    2054      * @param   idCpuCore    The core id of the CPU to add.
    2055      * @param   idCpuPackage The package id of the CPU to add.
     2068     * @param   pInterface      Pointer to the interface structure containing the called function pointer.
     2069     * @param   idCpuCore       The core id of the CPU to add.
     2070     * @param   idCpuPackage    The package id of the CPU to add.
    20562071     */
    20572072    DECLR3CALLBACKMEMBER(int, pfnCpuHotPlug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
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