VirtualBox

Changeset 67640 in vbox for trunk/include/VBox


Ignore:
Timestamp:
Jun 27, 2017 3:23:45 PM (8 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
116413
Message:

Utf8Str::parseKeyValue: Docs and style.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/VBox/com/string.h

    r62476 r67640  
    764764    Utf8Str& stripSuffix();
    765765
    766     // Parse key=value pairs from string
    767     size_t parseKeyValue(Utf8Str &key, Utf8Str &value, size_t pos = 0, const Utf8Str &pairSeparator = ",", const Utf8Str &keyValueSeparator = "=") const;
     766    /**
     767     * Parses key=value pairs.
     768     *
     769     * @returns offset of the @a a_rPairSeparator following the returned value.
     770     * @retval  npos is returned if there are no more key/value pairs, or if the
     771     *          final key/value pair isn't followed by a @a a_rPairSeparator.
     772     *
     773     * @param   a_rKey                  Reference to variable that should receive
     774     *                                  the key substring.  This is set to null if
     775     *                                  no key/value found.  (It's also possible the
     776     *                                  key is an empty string, so be careful.)
     777     * @param   a_rValue                Reference to variable that should receive
     778     *                                  the value substring.  This is set to null if
     779     *                                  no key/value found.  (It's also possible the
     780     *                                  value is an empty string, so be careful.)
     781     * @param   a_offStart              The offset to start searching from.  This is
     782     *                                  typically 0 for the first call, and the
     783     *                                  return value of the previous call for the
     784     *                                  subsequent ones.
     785     * @param   a_rPairSeparator        The pair separator string.
     786     * @param   a_rKeyValueSeparator    The key/value separator string.
     787     */
     788    size_t parseKeyValue(Utf8Str &a_rKey, Utf8Str &a_rValue, size_t a_offStart = 0,
     789                         const Utf8Str &a_rPairSeparator = ",", const Utf8Str &a_rKeyValueSeparator = "=") const;
    768790
    769791    /**
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette