VirtualBox

Changeset 84837 in vbox for trunk


Ignore:
Timestamp:
Jun 15, 2020 7:33:35 PM (5 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
138648
Message:

Guest Control/VbglR3: Docs. bugref:9320.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • TabularUnified trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp

    r84822 r84837  
    508508
    509509
     510/**
     511 * Replies to a message from the host.
     512 *
     513 * @returns VBox status code.
     514 * @param   pCtx                Guest control command context to use.
     515 * @param   rc                  Guest rc to reply.
     516 */
    510517VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx,
    511518                                        int rc)
    … …  
    516523
    517524
     525/**
     526 * Replies to a message from the host, extended version.
     527 *
     528 * @returns VBox status code.
     529 * @param   pCtx                Guest control command context to use.
     530 * @param   rc                  Guest rc to reply.
     531 * @param   uType               Reply type; not used yet and must be 0.
     532 * @param   pvPayload           Pointer to data payload to reply. Optional.
     533 * @param   cbPayload           Size of data payload (in bytes) to reply.
     534 */
    518535VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx,
    519536                                          int rc, uint32_t uType,
    … …  
    688705 *
    689706 * @return  IPRT status code.
    690  * @param   pCtx                    Host context.
     707 * @param   pCtx                    Guest control command context to use.
    691708 * @param   fFlags                  Some kind of flag. Figure it out yourself.
    692  ** @todo Docs!
    693709 */
    694710VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags)
    … …  
    706722
    707723
     724/**
     725 * Notifies a guest session.
     726 *
     727 * @returns VBox status code.
     728 * @param   pCtx                    Guest control command context to use.
     729 * @param   uType                   Notification type of type GUEST_SESSION_NOTIFYTYPE_XXX.
     730 * @param   iResult                 Result code (rc) to notify.
     731 */
    708732VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, int32_t iResult)
    709733{
    … …  
    13351359
    13361360/**
    1337  * Allocates and gets host data, based on the message id.
     1361 * Allocates and gets host data, based on the message ID.
    13381362 *
    13391363 * This will block until data becomes available.
    13401364 *
    13411365 * @returns VBox status code.
    1342  ** @todo Docs!
     1366 * @param   pCtx                    Guest control command context to use.
     1367 * @param   puPID                   Where to return the guest PID to retrieve output from on success.
     1368 * @param   puHandle                Where to return the guest process handle to retrieve output from on success.
     1369 * @param   pfFlags                 Where to return the output flags on success.
    13431370 */
    13441371VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
    … …  
    18441871
    18451872
     1873/**
     1874 * Replies to a HOST_MSG_FILE_OPEN message.
     1875 *
     1876 * @returns VBox status code.
     1877 * @param   pCtx                Guest control command context to use.
     1878 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1879 * @param   uFileHandle         File handle of opened file on success.
     1880 */
    18461881VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx,
    18471882                                          uint32_t uRc, uint32_t uFileHandle)
    … …  
    18601895
    18611896
     1897/**
     1898 * Replies to a HOST_MSG_FILE_CLOSE message.
     1899 *
     1900 * @returns VBox status code.
     1901 * @param   pCtx                Guest control command context to use.
     1902 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1903 */
    18621904VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx,
    18631905                                           uint32_t uRc)
    … …  
    18751917
    18761918
     1919/**
     1920 * Sends an unexpected file handling error to the host.
     1921 *
     1922 * @returns VBox status code.
     1923 * @param   pCtx                Guest control command context to use.
     1924 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1925 */
    18771926VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
    18781927{
    … …  
    18891938
    18901939
     1940/**
     1941 * Replies to a HOST_MSG_FILE_READ message.
     1942 *
     1943 * @returns VBox status code.
     1944 * @param   pCtx                Guest control command context to use.
     1945 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1946 * @param   pvData              Pointer to read file data from guest on success.
     1947 * @param   cbData              Size (in bytes) of read file data from guest on success.
     1948 */
    18911949VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx,
    18921950                                          uint32_t uRc,
    … …  
    19061964
    19071965
     1966/**
     1967 * Replies to a HOST_MSG_FILE_READ_AT message.
     1968 *
     1969 * @returns VBox status code.
     1970 * @param   pCtx                Guest control command context to use.
     1971 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1972 * @param   pvData              Pointer to read file data from guest on success.
     1973 * @param   cbData              Size (in bytes) of read file data from guest on success.
     1974 * @param   offNew              New offset (in bytes) the guest file pointer points at on success.
     1975 */
    19081976VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
    19091977                                                void *pvData, uint32_t cbData, int64_t offNew)
    … …  
    19231991
    19241992
     1993/**
     1994 * Replies to a HOST_MSG_FILE_WRITE message.
     1995 *
     1996 * @returns VBox status code.
     1997 * @param   pCtx                Guest control command context to use.
     1998 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     1999 * @param   cbWritten           Size (in bytes) of file data successfully written to guest file. Can be partial.
     2000 */
    19252001VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten)
    19262002{
    … …  
    19382014
    19392015
     2016/**
     2017 * Replies to a HOST_MSG_FILE_WRITE_AT message.
     2018 *
     2019 * @returns VBox status code.
     2020 * @param   pCtx                Guest control command context to use.
     2021 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     2022 * @param   cbWritten           Size (in bytes) of file data successfully written to guest file. Can be partial.
     2023 * @param   offNew              New offset (in bytes) the guest file pointer points at on success.
     2024 */
    19402025VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew)
    19412026{
    … …  
    19542039
    19552040
     2041/**
     2042 * Replies to a HOST_MSG_FILE_SEEK message.
     2043 *
     2044 * @returns VBox status code.
     2045 * @param   pCtx                Guest control command context to use.
     2046 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     2047 * @param   offCurrent          New offset (in bytes) the guest file pointer points at on success.
     2048 */
    19562049VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
    19572050{
    … …  
    19692062
    19702063
     2064/**
     2065 * Replies to a HOST_MSG_FILE_TELL message.
     2066 *
     2067 * @returns VBox status code.
     2068 * @param   pCtx                Guest control command context to use.
     2069 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     2070 * @param   offCurrent          Current offset (in bytes) the guest file pointer points at on success.
     2071 */
    19712072VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
    19722073{
    … …  
    19842085
    19852086
     2087/**
     2088 * Replies to a HOST_MSG_FILE_SET_SIZE message.
     2089 *
     2090 * @returns VBox status code.
     2091 * @param   pCtx                Guest control command context to use.
     2092 * @param   uRc                 Guest rc of operation (note: IPRT-style signed int).
     2093 * @param   cbNew               New file size (in bytes) of the guest file on success.
     2094 */
    19862095VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew)
    19872096{
    … …  
    20032112 *
    20042113 * @returns VBox status code.
    2005  ** @todo Docs!
     2114 * @param   pCtx                Guest control command context to use.
     2115 * @param   uPID                Guest process PID to report status for.
     2116 * @param   uStatus             Status to report. Of type PROC_STS_XXX.
     2117 * @param   fFlags              Additional status flags, depending on the reported status. See RTPROCSTATUS.
     2118 * @param   pvData              Pointer to additional status data. Optional.
     2119 * @param   cbData              Size (in bytes) of additional status data.
    20062120 */
    20072121VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx,
    … …  
    20272141 *
    20282142 * @returns VBox status code.
    2029  ** @todo Docs!
     2143 * @param   pCtx                Guest control command context to use.
     2144 * @param   uPID                Guest process PID to report status for.
     2145 * @param   uHandle             Guest process handle the output belong to.
     2146 * @param   fFlags              Additional output flags.
     2147 * @param   pvData              Pointer to actual output data.
     2148 * @param   cbData              Size (in bytes) of output data.
    20302149 */
    20312150VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
    … …  
    20512170 *
    20522171 * @returns VBox status code.
    2053  ** @todo Docs!
     2172 * @param   pCtx                Guest control command context to use.
     2173 * @param   uPID                Guest process PID to report status for.
     2174 * @param   uStatus             Status to report. Of type INPUT_STS_XXX.
     2175 * @param   fFlags              Additional input flags.
     2176 * @param   cbWritten           Size (in bytes) of input data handled.
    20542177 */
    20552178VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
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