Changeset 47762 in vbox for trunk/include/iprt

Timestamp:

Aug 15, 2013 1:04:51 PM (11 years ago)

Author:

vboxsync

Message:

IPRT: Added RTFileModeToFlags* APIs + testcase.

Location:

trunk/include/iprt

Files:

• file.h (modified) (1 diff)
• mangling.h (modified) (1 diff)

trunk/include/iprt/file.h

@@ -601 +601 @@
 
 /**
+ * Converts file opening modes (used by fopen, for example) to IPRT
+ * compatible flags, which then can be used with RTFileOpen* APIs.
+ *
+ * @return  IPRT status code.
+ * @param   pszMode                 Mode string to convert.
+ * @param   puMode                  Where to store the converted mode flags
+ *                                  on success.
+ */
+RTDECL(int) RTFileModeToFlags(const char *pszMode, uint64_t *puMode);
+
+/**
+ * Converts file opening modes along with a separate disposition command
+ * to IPRT compatible flags, which then can be used with RTFileOpen* APIs.
+ *
+ * Access modes:
+ *      "r"  - Read
+ *      "r+" - Read / Write
+ *      "w"  - Write
+ *      "w+" - Write / Read
+ *
+ * Disposition modes:
+ *      "ca" - Create a new file, always, overwrite existing
+ *      "ce" - Create a new file if not exist, fail if exist
+ *      "oc" - Open existing, create if not exist
+ *      "oe" - Open existing, fail if not exist
+ *      "ot" - Open and truncate existing, fail of not exist
+ *
+ * Sharing modes:
+ *      Not implemented yet.
+ *
+ * @return  IPRT status code.
+ * @param   pszAccess               Access mode string to convert.
+ * @param   pszDisposition          Disposition mode string to convert.
+ * @param   pszSharing              Sharing mode string to convert. Not
+ *                                  implemented yet.
+ * @param   puMode                  Where to store the converted mode flags
+ *                                  on success.
+ */
+RTDECL(int) RTFileModeToFlagsEx(const char *pszAccess, const char *pszDisposition, const char *pszSharing, uint64_t *puMode);
+
+/**
  * Moves a file.
  *

trunk/include/iprt/mangling.h

@@ -539 +539 @@
 # define RTFileIsValid                                  RT_MANGLER(RTFileIsValid)
 # define RTFileLock                                     RT_MANGLER(RTFileLock)
+# define RTFileModeToFlags                              RT_MANGLER(RTFileModeToFlags)
+# define RTFileModeToFlagsEx                            RT_MANGLER(RTFileModeToFlagsEx)
 # define RTFileMove                                     RT_MANGLER(RTFileMove)
 # define RTFileOpen                                     RT_MANGLER(RTFileOpen)