Changeset 69742 in vbox for trunk/include/iprt

Timestamp:

Nov 18, 2017 4:58:38 AM (7 years ago)

Author:

vboxsync

Message:

IPRT: Added RTGetOptFormatError.

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/getopt.h

@@ -427 +427 @@
 
 /**
+ * Formats error messages for a RTGetOpt default case.
+ *
+ * @returns On success, positive count of formatted character excluding the
+ *          terminator.  On buffer overflow, negative number giving the required
+ *          buffer size (including terminator char).  (RTStrPrintf2 style.)
+ *
+ * @param   pszBuf      The buffer to format into.
+ * @param   cbBuf       The size of the buffer @a pszBuf points to.
+ * @param   ch          The RTGetOpt return value.
+ * @param   pValueUnion The value union returned by RTGetOpt.
+ */
+RTDECL(ssize_t) RTGetOptFormatError(char *pszBuf, size_t cbBuf, int ch, PCRTGETOPTUNION pValueUnion);
+
+/**
  * Parses the @a pszCmdLine string into an argv array.
  *

trunk/include/iprt/mangling.h

@@ -1005 +1005 @@
 # define RTGetOptInit                                   RT_MANGLER(RTGetOptInit)
 # define RTGetOptNonOptionArrayPtr                      RT_MANGLER(RTGetOptNonOptionArrayPtr)
+# define RTGetOptFormatError                            RT_MANGLER(RTGetOptFormatError)
 # define RTGetOptPrintError                             RT_MANGLER(RTGetOptPrintError)
 # define RTHandleClose                                  RT_MANGLER(RTHandleClose)