VirtualBox

Changeset 58154 in vbox for trunk/include/VBox


Ignore:
Timestamp:
Oct 9, 2015 3:07:17 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
103262
Message:

Doxygen: fixes

Location:
trunk/include/VBox
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/VBoxGuestLib.h

    r58111 r58154  
    203203 */
    204204
    205 DECLR0VBGL(int) VbglR0HGCMInternalConnect (VBoxGuestHGCMConnectInfo *pConnectInfo,
    206                                            PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
     205DECLR0VBGL(int) VbglR0HGCMInternalConnect(VBoxGuestHGCMConnectInfo *pConnectInfo,
     206                                          PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
    207207
    208208
    … …  
    224224 */
    225225
    226 DECLR0VBGL(int) VbglR0HGCMInternalDisconnect (VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
    227                                               PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
     226DECLR0VBGL(int) VbglR0HGCMInternalDisconnect(VBoxGuestHGCMDisconnectInfo *pDisconnectInfo,
     227                                             PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
    228228
    229229/** Call a HGCM service.
    … …  
    241241 * @return VBox status code.
    242242 */
    243 DECLR0VBGL(int) VbglR0HGCMInternalCall (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
    244                                         PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
     243DECLR0VBGL(int) VbglR0HGCMInternalCall(VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
     244                                       PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
    245245
    246246/** Call a HGCM service. (32 bits packet structure in a 64 bits guest)
    … …  
    258258 * @return  VBox status code.
    259259 */
    260 DECLR0VBGL(int) VbglR0HGCMInternalCall32 (VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
    261                                           PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
     260DECLR0VBGL(int) VbglR0HGCMInternalCall32(VBoxGuestHGCMCallInfo *pCallInfo, uint32_t cbCallInfo, uint32_t fFlags,
     261                                         PFNVBGLHGCMCALLBACK pfnAsyncCallback, void *pvAsyncData, uint32_t u32AsyncData);
    262262
    263263/** @name VbglR0HGCMInternalCall flags
    … …  
    294294 * @return VBox status code.
    295295 */
    296 DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
     296DECLVBGL(int) VbglHGCMConnect(VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
    297297
    298298/**
    … …  
    304304 * @return VBox status code.
    305305 */
    306 DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
     306DECLVBGL(int) VbglHGCMDisconnect(VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
    307307
    308308/**
    … …  
    315315 * @return VBox status code.
    316316 */
    317 DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
     317DECLVBGL(int) VbglHGCMCall(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
    318318
    319319/**
    … …  
    327327 * @return VBox status code.
    328328 */
    329 DECLVBGL(int) VbglHGCMCallUserData (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
     329DECLVBGL(int) VbglHGCMCallUserData(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
    330330
    331331/**
    … …  
    339339 * @return VBox status code.
    340340 */
    341 DECLVBGL(int) VbglHGCMCallTimed (VBGLHGCMHANDLE handle,
    342                                  VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
     341DECLVBGL(int) VbglHGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
    343342/** @} */
    344343
    … …  
    351350 * Initialize the heap.
    352351 *
    353  * @return VBox error code.
    354  */
    355 DECLVBGL(int) VbglPhysHeapInit (void);
     352 * @returns VBox status code.
     353 */
     354DECLVBGL(int) VbglPhysHeapInit(void);
    356355
    357356/**
    358357 * Shutdown the heap.
    359358 */
    360 DECLVBGL(void) VbglPhysHeapTerminate (void);
    361 
     359DECLVBGL(void) VbglPhysHeapTerminate(void);
    362360
    363361/**
    364362 * Allocate a memory block.
    365363 *
    366  * @param cbSize    Size of block to be allocated.
    367  * @return Virtual address of allocated memory block.
    368  */
    369 DECLVBGL(void *) VbglPhysHeapAlloc (uint32_t cbSize);
    370 
    371 /**
    372  * Get physical address of memory block pointed by
    373  * the virtual address.
     364 * @returns Virtual address of the allocated memory block.
     365 * @param   cbSize    Size of block to be allocated.
     366 */
     367DECLVBGL(void *) VbglPhysHeapAlloc(uint32_t cbSize);
     368
     369/**
     370 * Get physical address of memory block pointed by the virtual address.
    374371 *
    375372 * @note WARNING!
    376373 *       The function does not acquire the Heap mutex!
    377  *       When calling the function make sure that
    378  *       the pointer is a valid one and is not being
    379  *       deallocated.
    380  *       This function can NOT be used for verifying
    381  *       if the given pointer is a valid one allocated
    382  *       from the heap.
    383  *
    384  *
    385  * @param p    Virtual address of memory block.
    386  * @return Physical address of the memory block.
    387  */
    388 DECLVBGL(uint32_t) VbglPhysHeapGetPhysAddr (void *p);
     374 *       When calling the function make sure that the pointer is a valid one and
     375 *       is not being deallocated.  This function can NOT be used for verifying
     376 *       if the given pointer is a valid one allocated from the heap.
     377 *
     378 * @param   pv      Virtual address of memory block.
     379 * @returns Physical address of the memory block.
     380 */
     381DECLVBGL(uint32_t)  VbglPhysHeapGetPhysAddr(void *pv);
    389382
    390383/**
    391384 * Free a memory block.
    392385 *
    393  * @param p    Virtual address of memory block.
    394  */
    395 DECLVBGL(void) VbglPhysHeapFree (void *p);
    396 
    397 DECLVBGL(int) VbglQueryVMMDevMemory (VMMDevMemory **ppVMMDevMemory);
    398 DECLR0VBGL(bool) VbglR0CanUsePhysPageList(void);
     386 * @param   pv    Virtual address of memory block.
     387 */
     388DECLVBGL(void)      VbglPhysHeapFree(void *pv);
     389
     390DECLVBGL(int)       VbglQueryVMMDevMemory(VMMDevMemory **ppVMMDevMemory);
     391DECLR0VBGL(bool)    VbglR0CanUsePhysPageList(void);
    399392
    400393# ifndef VBOX_GUEST
    401394/** @name Mouse
    402395 * @{ */
    403 DECLVBGL(int)     VbglSetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
    404 DECLVBGL(int)     VbglGetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
    405 DECLVBGL(int)     VbglSetMouseStatus(uint32_t fFeatures);
     396DECLVBGL(int)       VbglSetMouseNotifyCallback(PFNVBOXGUESTMOUSENOTIFY pfnNotify, void *pvUser);
     397DECLVBGL(int)       VbglGetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
     398DECLVBGL(int)       VbglSetMouseStatus(uint32_t fFeatures);
    406399/** @}  */
    407400# endif /* VBOX_GUEST */
    … …  
    439432VBGLR3DECL(int)     VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents);
    440433
    441 VBGLR3DECL(int)     VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent, uint32_t uFlags);
     434VBGLR3DECL(int)     VbglR3ReportAdditionsStatus(VBoxGuestFacilityType Facility, VBoxGuestFacilityStatus StatusCurrent,
     435                                                uint32_t fFlags);
    442436VBGLR3DECL(int)     VbglR3GetAdditionsVersion(char **ppszVer, char **ppszVerEx, char **ppszRev);
    443437VBGLR3DECL(int)     VbglR3GetAdditionsInstallationPath(char **ppszPath);
    … …  
    448442/** @name Shared clipboard
    449443 * @{ */
    450 VBGLR3DECL(int)     VbglR3ClipboardConnect(uint32_t *pu32ClientId);
    451 VBGLR3DECL(int)     VbglR3ClipboardDisconnect(uint32_t u32ClientId);
    452 VBGLR3DECL(int)     VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
    453 VBGLR3DECL(int)     VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
    454 VBGLR3DECL(int)     VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
    455 VBGLR3DECL(int)     VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
     444VBGLR3DECL(int)     VbglR3ClipboardConnect(uint32_t *pidClient);
     445VBGLR3DECL(int)     VbglR3ClipboardDisconnect(uint32_t idClient);
     446VBGLR3DECL(int)     VbglR3ClipboardGetHostMsg(uint32_t idClient, uint32_t *pMsg, uint32_t *pfFormats);
     447VBGLR3DECL(int)     VbglR3ClipboardReadData(uint32_t idClient, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
     448VBGLR3DECL(int)     VbglR3ClipboardReportFormats(uint32_t idClient, uint32_t fFormats);
     449VBGLR3DECL(int)     VbglR3ClipboardWriteData(uint32_t idClient, uint32_t fFormat, void *pv, uint32_t cb);
    456450/** @} */
    457451
    … …  
    475469VBGLR3DECL(int)     VbglR3VideoAccelEnable(bool fEnable);
    476470VBGLR3DECL(int)     VbglR3VideoAccelFlush(void);
    477 VBGLR3DECL(int)     VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy, const void *pvImg, size_t cbImg);
     471VBGLR3DECL(int)     VbglR3SetPointerShape(uint32_t fFlags, uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
     472                                          const void *pvImg, size_t cbImg);
    478473VBGLR3DECL(int)     VbglR3SetPointerShapeReq(struct VMMDevReqMousePointer *pReq);
    479474/** @}  */
    … …  
    482477 * @{ */
    483478/** The folder for the video mode hint unix domain socket on Unix-like guests.
    484  */
    485 /** @note This can be safely changed as all users are rebuilt in lock-step. */
    486 #define VBGLR3HOSTDISPSOCKETPATH "/tmp/.VBoxService"
     479 * @note This can be safely changed as all users are rebuilt in lock-step. */
     480#define VBGLR3HOSTDISPSOCKETPATH    "/tmp/.VBoxService"
    487481/** The path to the video mode hint unix domain socket on Unix-like guests. */
    488 #define VBGLR3HOSTDISPSOCKET     VBGLR3VIDEOMODEHINTSOCKETPATH \
    489     "/VideoModeHint"
     482#define VBGLR3HOSTDISPSOCKET        VBGLR3VIDEOMODEHINTSOCKETPATH "/VideoModeHint"
    490483
    491484/** The folder for saving video mode hints to between sessions. */
    492485#define VBGLR3HOSTDISPSAVEDMODEPATH "/var/lib/VBoxGuestAdditions"
    493486/** The path to the file for saving video mode hints to between sessions. */
    494 #define VBGLR3HOSTDISPSAVEDMODE     VBGLR3HOSTDISPSAVEDMODEPATH \
    495     "/SavedVideoModes"
    496 
    497 VBGLR3DECL(int)     VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy,
    498                                                   uint32_t *pcBits,
    499                                                   uint32_t *piDisplay,
    500                                                   uint32_t *pdx, uint32_t *pdy,
    501                                                   bool *pfEnabled,
    502                                                   bool *pfChangeOrigin,
    503                                                   bool fAck);
     487#define VBGLR3HOSTDISPSAVEDMODE     VBGLR3HOSTDISPSAVEDMODEPATH "/SavedVideoModes"
     488
     489VBGLR3DECL(int)     VbglR3GetDisplayChangeRequest(uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits, uint32_t *piDisplay,
     490                                                  uint32_t *pdx, uint32_t *pdy, bool *pfEnabled, bool *pfChangeOrigin, bool fAck);
    504491VBGLR3DECL(bool)    VbglR3HostLikesVideoMode(uint32_t cx, uint32_t cy, uint32_t cBits);
    505492VBGLR3DECL(int)     VbglR3VideoModeGetHighestSavedScreen(unsigned *pcScreen);
    506 VBGLR3DECL(int)     VbglR3SaveVideoMode(unsigned cScreen, unsigned cx,
    507                                         unsigned cy, unsigned cBits, unsigned x,
    508                                         unsigned y, bool fEnabled);
    509 VBGLR3DECL(int)     VbglR3RetrieveVideoMode(unsigned cScreen, unsigned *pcx,
    510                                             unsigned *pcy, unsigned *pcBits,
    511                                             unsigned *px, unsigned *py,
    512                                             bool *pfEnabled);
     493VBGLR3DECL(int)     VbglR3SaveVideoMode(unsigned cScreen, unsigned cx, unsigned cy, unsigned cBits,
     494                                        unsigned x, unsigned y, bool fEnabled);
     495VBGLR3DECL(int)     VbglR3RetrieveVideoMode(unsigned cScreen, unsigned *pcx, unsigned *pcy, unsigned *pcBits,
     496                                            unsigned *px, unsigned *py, bool *pfEnabled);
    513497/** @}  */
    514498
    … …  
    538522/** @todo Docs. */
    539523typedef VBGLR3GUESTPROPENUM *PVBGLR3GUESTPROPENUM;
    540 VBGLR3DECL(int)     VbglR3GuestPropConnect(uint32_t *pu32ClientId);
    541 VBGLR3DECL(int)     VbglR3GuestPropDisconnect(uint32_t u32ClientId);
    542 VBGLR3DECL(int)     VbglR3GuestPropWrite(uint32_t u32ClientId, const char *pszName, const char *pszValue, const char *pszFlags);
    543 VBGLR3DECL(int)     VbglR3GuestPropWriteValue(uint32_t u32ClientId, const char *pszName, const char *pszValue);
    544 VBGLR3DECL(int)     VbglR3GuestPropWriteValueV(uint32_t u32ClientId, const char *pszName,
     524VBGLR3DECL(int)     VbglR3GuestPropConnect(uint32_t *pidClient);
     525VBGLR3DECL(int)     VbglR3GuestPropDisconnect(uint32_t idClient);
     526VBGLR3DECL(int)     VbglR3GuestPropWrite(uint32_t idClient, const char *pszName, const char *pszValue, const char *pszFlags);
     527VBGLR3DECL(int)     VbglR3GuestPropWriteValue(uint32_t idClient, const char *pszName, const char *pszValue);
     528VBGLR3DECL(int)     VbglR3GuestPropWriteValueV(uint32_t idClient, const char *pszName,
    545529                                               const char *pszValueFormat, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
    546 VBGLR3DECL(int)     VbglR3GuestPropWriteValueF(uint32_t u32ClientId, const char *pszName,
     530VBGLR3DECL(int)     VbglR3GuestPropWriteValueF(uint32_t idClient, const char *pszName,
    547531                                               const char *pszValueFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
    548 VBGLR3DECL(int)     VbglR3GuestPropRead(uint32_t u32ClientId, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
    549 VBGLR3DECL(int)     VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue, uint32_t *pcchValueActual);
    550 VBGLR3DECL(int)     VbglR3GuestPropReadValueAlloc(uint32_t u32ClientId, const char *pszName, char **ppszValue);
     532VBGLR3DECL(int)     VbglR3GuestPropRead(uint32_t idClient, const char *pszName, void *pvBuf, uint32_t cbBuf, char **ppszValue,
     533                                        uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
     534VBGLR3DECL(int)     VbglR3GuestPropReadValue(uint32_t ClientId, const char *pszName, char *pszValue, uint32_t cchValue,
     535                                             uint32_t *pcchValueActual);
     536VBGLR3DECL(int)     VbglR3GuestPropReadValueAlloc(uint32_t idClient, const char *pszName, char **ppszValue);
    551537VBGLR3DECL(void)    VbglR3GuestPropReadValueFree(char *pszValue);
    552 VBGLR3DECL(int)     VbglR3GuestPropEnumRaw(uint32_t u32ClientId, const char *paszPatterns, char *pcBuf, uint32_t cbBuf, uint32_t *pcbBufActual);
    553 VBGLR3DECL(int)     VbglR3GuestPropEnum(uint32_t u32ClientId, char const * const *ppaszPatterns, uint32_t cPatterns, PVBGLR3GUESTPROPENUM *ppHandle,
    554                                         char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp, char const **ppszFlags);
    555 VBGLR3DECL(int)     VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue, uint64_t *pu64Timestamp,
    556                                             char const **ppszFlags);
     538VBGLR3DECL(int)     VbglR3GuestPropEnumRaw(uint32_t idClient, const char *paszPatterns, char *pcBuf, uint32_t cbBuf,
     539                                           uint32_t *pcbBufActual);
     540VBGLR3DECL(int)     VbglR3GuestPropEnum(uint32_t idClient, char const * const *ppaszPatterns, uint32_t cPatterns,
     541                                        PVBGLR3GUESTPROPENUM *ppHandle, char const **ppszName, char const **ppszValue,
     542                                        uint64_t *pu64Timestamp, char const **ppszFlags);
     543VBGLR3DECL(int)     VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle, char const **ppszName, char const **ppszValue,
     544                                            uint64_t *pu64Timestamp, char const **ppszFlags);
    557545VBGLR3DECL(void)    VbglR3GuestPropEnumFree(PVBGLR3GUESTPROPENUM pHandle);
    558 VBGLR3DECL(int)     VbglR3GuestPropDelete(uint32_t u32ClientId, const char *pszName);
    559 VBGLR3DECL(int)     VbglR3GuestPropDelSet(uint32_t u32ClientId, char const * const *papszPatterns, uint32_t cPatterns);
    560 VBGLR3DECL(int)     VbglR3GuestPropWait(uint32_t u32ClientId, const char *pszPatterns, void *pvBuf, uint32_t cbBuf, uint64_t u64Timestamp, uint32_t cMillies, char ** ppszName, char **ppszValue, uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
     546VBGLR3DECL(int)     VbglR3GuestPropDelete(uint32_t idClient, const char *pszName);
     547VBGLR3DECL(int)     VbglR3GuestPropDelSet(uint32_t idClient, char const * const *papszPatterns, uint32_t cPatterns);
     548VBGLR3DECL(int)     VbglR3GuestPropWait(uint32_t idClient, const char *pszPatterns, void *pvBuf, uint32_t cbBuf,
     549                                        uint64_t u64Timestamp, uint32_t cMillies, char ** ppszName, char **ppszValue,
     550                                        uint64_t *pu64Timestamp, char **ppszFlags, uint32_t *pcbBufActual);
    561551/** @}  */
    562552
    563553/** @name Guest user handling / reporting.
    564554 * @{ */
    565 VBGLR3DECL(int)     VbglR3GuestUserReportState(const char *pszUser, const char *pszDomain, VBoxGuestUserState enmState, uint8_t *puDetails, uint32_t cbDetails);
     555VBGLR3DECL(int)     VbglR3GuestUserReportState(const char *pszUser, const char *pszDomain, VBoxGuestUserState enmState,
     556                                               uint8_t *pbDetails, uint32_t cbDetails);
    566557/** @}  */
    567558
    568559/** @name Host version handling
    569560 * @{ */
    570 VBGLR3DECL(int)     VbglR3HostVersionCheckForUpdate(uint32_t u32ClientId, bool *pfUpdate, char **ppszHostVersion, char **ppszGuestVersion);
    571 VBGLR3DECL(int)     VbglR3HostVersionLastCheckedLoad(uint32_t u32ClientId, char **ppszVer);
    572 VBGLR3DECL(int)     VbglR3HostVersionLastCheckedStore(uint32_t u32ClientId, const char *pszVer);
     561VBGLR3DECL(int)     VbglR3HostVersionCheckForUpdate(uint32_t idClient, bool *pfUpdate, char **ppszHostVersion,
     562                                                    char **ppszGuestVersion);
     563VBGLR3DECL(int)     VbglR3HostVersionLastCheckedLoad(uint32_t idClient, char **ppszVer);
     564VBGLR3DECL(int)     VbglR3HostVersionLastCheckedStore(uint32_t idClient, const char *pszVer);
    573565/** @}  */
    574566# endif /* VBOX_WITH_GUEST_PROPS defined */
    … …  
    592584typedef VBGLR3SHAREDFOLDERMAPPING const *PCVBGLR3SHAREDFOLDERMAPPING;
    593585
    594 VBGLR3DECL(int)     VbglR3SharedFolderConnect(uint32_t *pu32ClientId);
    595 VBGLR3DECL(int)     VbglR3SharedFolderDisconnect(uint32_t u32ClientId);
    596 VBGLR3DECL(bool)    VbglR3SharedFolderExists(uint32_t u32ClientId, const char *pszShareName);
    597 VBGLR3DECL(int)     VbglR3SharedFolderGetMappings(uint32_t u32ClientId, bool fAutoMountOnly,
     586VBGLR3DECL(int)     VbglR3SharedFolderConnect(uint32_t *pidClient);
     587VBGLR3DECL(int)     VbglR3SharedFolderDisconnect(uint32_t idClient);
     588VBGLR3DECL(bool)    VbglR3SharedFolderExists(uint32_t idClient, const char *pszShareName);
     589VBGLR3DECL(int)     VbglR3SharedFolderGetMappings(uint32_t idClient, bool fAutoMountOnly,
    598590                                                  PVBGLR3SHAREDFOLDERMAPPING *ppaMappings, uint32_t *pcMappings);
    599591VBGLR3DECL(void)    VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings);
    600 VBGLR3DECL(int)     VbglR3SharedFolderGetName(uint32_t  u32ClientId,uint32_t u32Root, char **ppszName);
     592VBGLR3DECL(int)     VbglR3SharedFolderGetName(uint32_t  idClient,uint32_t u32Root, char **ppszName);
    601593VBGLR3DECL(int)     VbglR3SharedFolderGetMountPrefix(char **ppszPrefix);
    602594VBGLR3DECL(int)     VbglR3SharedFolderGetMountDir(char **ppszDir);
    … …  
    635627
    636628/* General message handling on the guest. */
    637 VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *puClientId);
     629VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient);
    638630VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t uClientId);
    639631VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t uClientId, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove);
    640632VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterUnset(uint32_t uClientId);
    641633VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc);
    642 VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType, void *pvPayload, uint32_t cbPayload);
     634VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
     635                                          void *pvPayload, uint32_t cbPayload);
    643636VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t uClientId);
    644637VBGLR3DECL(int) VbglR3GuestCtrlMsgWaitFor(uint32_t uClientId, uint32_t *puMsg, uint32_t *puNumParms);
    645 VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t u32ClientId);
     638VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t idClient);
    646639/* Guest session handling. */
    647 VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uFlags);
     640VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags);
    648641VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, uint32_t uResult);
    649 VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puProtocol, char *pszUser, uint32_t  cbUser, char *pszPassword, uint32_t  cbPassword, char *pszDomain, uint32_t cbDomain, uint32_t *puFlags, uint32_t *puSessionID);
    650 VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puFlags, uint32_t *puSessionID);
     642VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puProtocol, char *pszUser, uint32_t cbUser,
     643                                              char *pszPassword, uint32_t  cbPassword, char *pszDomain, uint32_t cbDomain,
     644                                              uint32_t *pfFlags, uint32_t *puSessionID);
     645VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags, uint32_t *puSessionID);
    651646/* Guest path handling. */
    652 VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszSource, uint32_t cbSource, char *pszDest, uint32_t cbDest, uint32_t *puFlags);
     647VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszSource, uint32_t cbSource, char *pszDest,
     648                                             uint32_t cbDest, uint32_t *pfFlags);
    653649/* Guest process execution. */
    654 VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszCmd, uint32_t cbCmd, uint32_t *puFlags, char *pszArgs, uint32_t cbArgs, uint32_t *puNumArgs, char *pszEnv, uint32_t *pcbEnv, uint32_t *puNumEnvVars, char *pszUser, uint32_t cbUser, char *pszPassword, uint32_t cbPassword, uint32_t *puTimeoutMS, uint32_t *puPriority, uint64_t *puAffinity, uint32_t cbAffinity, uint32_t *pcAffinity);
     650VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszCmd, uint32_t cbCmd, uint32_t *pfFlags,
     651                                            char *pszArgs, uint32_t cbArgs, uint32_t *puNumArgs, char *pszEnv, uint32_t *pcbEnv,
     652                                            uint32_t *puNumEnvVars, char *pszUser, uint32_t cbUser, char *pszPassword,
     653                                            uint32_t cbPassword, uint32_t *puTimeoutMS, uint32_t *puPriority,
     654                                            uint64_t *puAffinity, uint32_t cbAffinity, uint32_t *pcAffinity);
    655655VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID);
    656 VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *puFlags, void *pvData, uint32_t cbData, uint32_t *pcbSize);
    657 VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *puHandle, uint32_t *puFlags);
    658 VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *puWaitFlags, uint32_t *puTimeoutMS);
     656VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *pfFlags, void *pvData,
     657                                            uint32_t cbData, uint32_t *pcbSize);
     658VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *puHandle, uint32_t *pfFlags);
     659VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID, uint32_t *puWaitFlags,
     660                                              uint32_t *puTimeoutMS);
    659661/* Guest native directory handling. */
    660 VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *puFlags);
     662VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *pfFlags);
    661663/* Guest native file handling. */
    662 VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszFileName, uint32_t cbFileName, char *pszOpenMode, uint32_t cbOpenMode, char *pszDisposition, uint32_t cbDisposition, char *pszSharing, uint32_t cbSharing, uint32_t *puCreationMode, uint64_t *puOffset);
     664VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszFileName, uint32_t cbFileName, char *pszOpenMode,
     665                                           uint32_t cbOpenMode, char *pszDisposition, uint32_t cbDisposition, char *pszSharing,
     666                                           uint32_t cbSharing, uint32_t *puCreationMode, uint64_t *puOffset);
    663667VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
    664668VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *puToRead);
    665 VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *puToRead, uint64_t *puOffset);
    666 VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, void *pvData, uint32_t cbData, uint32_t *pcbSize);
    667 VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, void *pvData, uint32_t cbData, uint32_t *pcbSize, uint64_t *puOffset);
    668 VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *puSeekMethod, uint64_t *puOffset);
     669VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
     670                                             uint32_t *puToRead, uint64_t *poffRead);
     671VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
     672                                            void *pvData, uint32_t cbData, uint32_t *pcbActual);
     673VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, void *pvData, uint32_t cbData,
     674                                              uint32_t *pcbActual, uint64_t *poffWrite);
     675VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
     676                                           uint32_t *puSeekMethod, uint64_t *poffSeek);
    669677VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle);
    670678/* Guest -> Host. */
    … …  
    676684VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
    677685VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t uOffActual);
    678 VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t uFlags, void *pvData, uint32_t cbData);
    679 VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t uFlags, void *pvData, uint32_t cbData);
    680 VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus, uint32_t uFlags, uint32_t cbWritten);
     686VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
     687                                            void *pvData, uint32_t cbData);
     688VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uPID, uint32_t uHandle, uint32_t fFlags,
     689                                            void *pvData, uint32_t cbData);
     690VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t u32PID, uint32_t uStatus,
     691                                                 uint32_t fFlags, uint32_t cbWritten);
    681692
    682693/** @}  */
    … …  
    708719/** @name Page sharing
    709720 * @{ */
    710 VBGLR3DECL(int)     VbglR3RegisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64  GCBaseAddr, uint32_t cbModule, unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
     721VBGLR3DECL(int)     VbglR3RegisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64  GCBaseAddr, uint32_t cbModule,
     722                                               unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
    711723VBGLR3DECL(int)     VbglR3UnregisterSharedModule(char *pszModuleName, char *pszVersion, RTGCPTR64  GCBaseAddr, uint32_t cbModule);
    712724VBGLR3DECL(int)     VbglR3CheckSharedModules(void);
    … …  
    770782
    771783VBGLR3DECL(int)     VbglR3DnDHGAcknowledgeOperation(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uAction);
    772 VBGLR3DECL(int)     VbglR3DnDHGRequestData(PVBGLR3GUESTDNDCMDCTX pCtx, const char* pcszFormat);
     784VBGLR3DECL(int)     VbglR3DnDHGRequestData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pszFormat);
    773785VBGLR3DECL(int)     VbglR3DnDHGSetProgress(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uStatus, uint8_t uPercent, int rcErr);
    774786#  ifdef VBOX_WITH_DRAG_AND_DROP_GH
    775 VBGLR3DECL(int)     VbglR3DnDGHAcknowledgePending(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uDefAction, uint32_t uAllActions, const char* pcszFormats);
     787VBGLR3DECL(int)     VbglR3DnDGHAcknowledgePending(PVBGLR3GUESTDNDCMDCTX pCtx, uint32_t uDefAction,
     788                                                  uint32_t uAllActions, const char *pszFormats);
    776789VBGLR3DECL(int)     VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pszFormat, void *pvData, uint32_t cbData);
    777790VBGLR3DECL(int)     VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);

  • trunk/include/VBox/vmm/pdmifs.h

    r58132 r58154  
    26412641     * @param   pszDomain           Domain the guest user is bound to. Optional.
    26422642     * @param   uState              New guest user state to notify host about.
    2643      * @param   puDetails           Pointer to optional state data.
     2643     * @param   pabDetails          Pointer to optional state data.
    26442644     * @param   cbDetails           Size (in bytes) of optional state data.
    26452645     * @thread  The emulation thread.
    26462646     */
    2647     DECLR3CALLBACKMEMBER(void, pfnUpdateGuestUserState,(PPDMIVMMDEVCONNECTOR pInterface, const char *pszUser, const char *pszDomain,
    2648                                                         uint32_t uState,
    2649                                                         const uint8_t *puDetails, uint32_t cbDetails));
     2647    DECLR3CALLBACKMEMBER(void, pfnUpdateGuestUserState,(PPDMIVMMDEVCONNECTOR pInterface, const char *pszUser,
     2648                                                        const char *pszDomain, uint32_t uState,
     2649                                                        const uint8_t *pabDetails, uint32_t cbDetails));
    26502650
    26512651    /**
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