Changeset 103480 in vbox for trunk/include

Timestamp:

Feb 20, 2024 3:21:35 PM (12 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added a ShClTransferTransformPath() function to make the paths more uniform. bugref:9437

Location:

trunk/include/VBox

Files:

• GuestHost/SharedClipboard-transfers.h (modified) (3 diffs)
• HostServices/VBoxClipboardSvc.h (modified) (2 diffs)

trunk/include/VBox/GuestHost/SharedClipboard-transfers.h

@@ -345 +345 @@
 typedef struct _SHCLOBJOPENCREATEPARMS
 {
-    /** Path to object to open / create. */
+    /** Path to object to open / create.
+     *  Always stored as UNIX-style paths ('/').
+     *  Backslashes ('\') can be part of a UNIX path though. */
     char                       *pszPath;
     /** Size (in bytes) of path to to object. */
@@ -421 +423 @@
     /** Size (in bytes) of the listing path. */
     uint32_t cbPath;
-    /** Listing path (absolute). If empty or NULL the listing's root path will be opened. */
+    /** Listing path (absolute). If empty or NULL the listing's root path will be opened.
+     *  We always use UNIX-style paths. */
     char    *pszPath;
 } SHCLLISTOPENPARMS;
@@ -1266 +1269 @@
 int ShClPathSanitize(char *pszPath, size_t cbPath);
 const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
+int ShClTransferTransformPath(char *pszPath, size_t cbPath);
 int ShClTransferValidatePath(const char *pcszPath, bool fMustExist);
 int ShClTransferResolvePathAbs(PSHCLTRANSFER pTransfer, const char *pszPath, uint32_t fFlags, char **ppszResolved);

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -990 +990 @@
     /** pointer, in: Filter string. */
     HGCMFunctionParameter pvFilter;
-    /** pointer, in: Listing poth. If empty or NULL the listing's root path will be opened. */
+    /** pointer, in: Listing path. If empty or NULL the listing's root path will be opened.
+     *  We always use UNIX-style paths. */
     HGCMFunctionParameter pvPath;
     /** uint64_t, out: List handle. */
@@ -1110 +1111 @@
     /** uint64_t, out: Object handle. */
     HGCMFunctionParameter uHandle;
-    /** pointer, in: Absoulte path of object to open/create. */
+    /** pointer, in: Absoulte path of object to open/create.
+     *  We always use UNIX-style paths. */
     HGCMFunctionParameter szPath;
     /** uint32_t in: Open / Create flags of type SHCL_OBJ_CF_. */