Changeset 93035 in vbox

Timestamp:

Dec 21, 2021 9:28:05 AM (3 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

149038

Message:

Guest Control/Main: Session docs.

File:

• trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp (modified) (10 diffs)

trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp

@@ -1036 +1036 @@
  * Unregisters a directory object from a guest session.
  *
- * @return VBox status code. VERR_NOT_FOUND if the directory is not registered (anymore).
- * @param  pDirectory           Directory object to unregister from session.
+ * @returns VBox status code. VERR_NOT_FOUND if the directory is not registered (anymore).
+ * @param   pDirectory          Directory object to unregister from session.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_directoryUnregister(GuestDirectory *pDirectory)
@@ -1494 +1496 @@
  * Unregisters a file object from a guest session.
  *
- * @return VBox status code. VERR_NOT_FOUND if the file is not registered (anymore).
- * @param  pFile                File object to unregister from session.
+ * @returns VBox status code. VERR_NOT_FOUND if the file is not registered (anymore).
+ * @param   pFile               File object to unregister from session.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_fileUnregister(GuestFile *pFile)
@@ -1591 +1595 @@
  * @param   prcGuest            Where to return the guest error when VERR_GSTCTL_GUEST_ERROR
  *                              was returned. Optional.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_fileOpenEx(const com::Utf8Str &aPath, FileAccessMode_T aAccessMode, FileOpenAction_T aOpenAction,
@@ -1620 +1626 @@
  * @param   prcGuest            Where to return the guest error when VERR_GSTCTL_GUEST_ERROR
  *                              was returned. Optional.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_fileOpen(const GuestFileOpenInfo &openInfo, ComObjPtr<GuestFile> &pFile, int *prcGuest)
@@ -2367 +2375 @@
  *
  * @returns VBox status code.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_objectsUnregister(void)
@@ -2505 +2515 @@
  * Returns the user's absolute documents path, if any.
  *
- * @return VBox status code.
- * @param  strPath              Where to store the user's document path.
- * @param  prcGuest             Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ * @returns VBox status code.
+ * @param   strPath             Where to store the user's document path.
+ * @param   prcGuest            Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
  *                              Any other return code indicates some host side error.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_pathUserDocuments(Utf8Str &strPath, int *prcGuest)
@@ -2555 +2567 @@
  * Returns the user's absolute home path, if any.
  *
- * @return VBox status code.
- * @param  strPath              Where to store the user's home path.
- * @param  prcGuest             Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ * @returns VBox status code.
+ * @param   strPath             Where to store the user's home path.
+ * @param   prcGuest            Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
  *                              Any other return code indicates some host side error.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_pathUserHome(Utf8Str &strPath, int *prcGuest)
@@ -2605 +2619 @@
  * Unregisters a process object from a guest session.
  *
- * @return VBox status code. VERR_NOT_FOUND if the process is not registered (anymore).
- * @param  pProcess             Process object to unregister from session.
+ * @returns VBox status code. VERR_NOT_FOUND if the process is not registered (anymore).
+ * @param   pProcess            Process object to unregister from session.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_processUnregister(GuestProcess *pProcess)
@@ -2658 +2674 @@
  * starting the process.
  *
- * @return  IPRT status code.
- * @param   procInfo
- * @param   pProcess
+ * @returns IPRT status code.
+ * @param   procInfo            Process startup info to use for starting the process.
+ * @param   pProcess            Where to return the created guest process object on success.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_processCreateEx(GuestProcessStartupInfo &procInfo, ComObjPtr<GuestProcess> &pProcess)
@@ -2935 +2953 @@
  *
  * @returns VBox status code. VERR_NOT_SUPPORTED if not supported by Guest Additions.
- * @param  fFlags               Guest shutdown flags.
- * @param  prcGuest             Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ * @param   fFlags              Guest shutdown flags.
+ * @param   prcGuest            Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
  *                              Any other return code indicates some host side error.
+ *
+ * @note    Takes the write lock.
  */
 int GuestSession::i_shutdown(uint32_t fFlags, int *prcGuest)