Changeset 50793 in vbox for trunk/include/iprt

Timestamp:

Mar 14, 2014 9:13:23 PM (11 years ago)

Author:

vboxsync

Message:

iprt: Added RTSTR_VALIDATE_ENCODING_EXACT_LENGTH for RTStrValidateEncodingEx and RTUtf16ValidateEncodingEx.

File:

• trunk/include/iprt/string.h (modified) (3 diffs)

trunk/include/iprt/string.h

@@ -677 +677 @@
  * VERR_BUFFER_OVERFLOW will be returned if the check fails. */
 #define RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED     RT_BIT_32(0)
+/** Check that the string is exactly the given length.
+ * If it terminates early, VERR_BUFFER_UNDERFLOW will be returned.  When used
+ * together with RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED, the given length must
+ * include the terminator or VERR_BUFFER_OVERFLOW will be returned. */
+#define RTSTR_VALIDATE_ENCODING_EXACT_LENGTH        RT_BIT_32(1)
 /** @} */
 
@@ -684 +689 @@
  * @returns iprt status code.
  * @param   psz         The string.
- * @param   cch         The max string length. Use RTSTR_MAX to process the entire string.
+ * @param   cch         The max string length (/ size).  Use RTSTR_MAX to
+ *                      process the entire string.
  * @param   fFlags      Combination of RTSTR_VALIDATE_ENCODING_XXX flags.
  */
@@ -3358 +3364 @@
  * @returns iprt status code.
  * @param   pwsz        The string.
- * @param   cch         The max string length. Use RTSTR_MAX to process the entire string.
+ * @param   cwc         The max string length (/ size) in UTF-16 units. Use
+ *                      RTSTR_MAX to process the entire string.
  * @param   fFlags      Combination of RTSTR_VALIDATE_ENCODING_XXX flags.
  */