1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
9 /** @ingroup group_funcmacro_string */
13 @returns @true if the pointer is either @NULL or points to an empty string,
18 bool wxIsEmpty(const char* p
);
21 This is a safe version of standard function @e strlen(): it does exactly
22 the same thing (i.e. returns the length of the string) except that it
23 returns 0 if @a p is the @NULL pointer.
27 size_t wxStrlen(const char* p
);
30 This function complements the standard C function @e stricmp() which
31 performs case-insensitive comparison.
33 @returns A negative value, 0, or positive value if @a p1 is less than,
34 equal to or greater than @a p2. The comparison is case-sensitive.
38 int wxStrcmp(const char* p1
, const char* p2
);
41 This function complements the standard C function @e strcmp() which performs
42 case-sensitive comparison.
44 @returns A negative value, 0, or positive value if @a p1 is less than,
45 equal to or greater than @e p2. The comparison is case-insensitive.
49 int wxStricmp(const char* p1
, const char* p2
);
52 @deprecated Use wxString instead.
54 This macro is defined as:
57 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
62 bool wxStringEq(const wxString
& s1
, const wxString
& s2
);
65 @deprecated Use wxString::Find() instead.
67 Returns @true if the substring @a s1 is found within @a s2, ignoring case
68 if @a exact is @false. If @a subString is @false, no substring matching is
73 bool wxStringMatch(const wxString
& s1
, const wxString
& s2
,
74 bool subString
= true, bool exact
= false);
77 This is a convenience function wrapping wxStringTokenizer which simply
78 returns all tokens found in the given @a string in an array.
80 Please see wxStringTokenizer::wxStringTokenizer() for a description of the
85 wxArrayString
wxStringTokenize(const wxString
& string
,
86 const wxString
& delims
= wxDEFAULT_DELIMITERS
,
87 wxStringTokenizerMode mode
= wxTOKEN_DEFAULT
);
90 This function replaces the dangerous standard function @e sprintf() and is
91 like @e snprintf() available on some platforms. The only difference with
92 @e sprintf() is that an additional argument - buffer size - is taken and
93 the buffer is never overflowed.
95 Returns the number of characters copied to the buffer or -1 if there is not
98 @see wxVsnprintf(), wxString::Printf()
102 int wxSnprintf(wxChar
* buf
, size_t len
, const wxChar
* format
, ...);
105 The same as wxSnprintf() but takes a @c va_list argument instead of an
106 arbitrary number of parameters.
108 @note If @c wxUSE_PRINTF_POS_PARAMS is set to 1, then this function
109 supports positional arguments (see wxString::Printf() for more
110 information). However other functions of the same family (wxPrintf(),
111 wxSprintf(), wxFprintf(), wxVfprintf(), wxVfprintf(), wxVprintf(),
112 wxVsprintf()) currently do not to support positional parameters even
113 when @c wxUSE_PRINTF_POS_PARAMS is 1.
115 @see wxSnprintf(), wxString::PrintfV()
119 int wxVsnprintf(wxChar
* buf
, size_t len
,
120 const wxChar
* format
, va_list argPtr
);