string(3Tcl) string(3Tcl)
string - Manipulate strings
string option arg ?arg ...?
Performs one of several string operations, depending on option. The
legal options (which may be abbreviated) are:
string compare string1 string2
Perform a character-by-character comparison of strings string1 and
string2 in the same way as the C strcmp procedure. Return -1, 0, or
1, depending on whether string1 is lexicographically less than,
equal to, or greater than string2.
string first string1 string2
Search string2 for a sequence of characters that exactly match the
characters in string1. If found, return the index of the first
character in the first such match within string2. If not found,
return -1.
string index string charIndex
Returns the charIndex'th character of the string argument. A
charIndex of 0 corresponds to the first character of the string. If
charIndex is less than 0 or greater than or equal to the length of
the string then an empty string is returned.
string last string1 string2
Search string2 for a sequence of characters that exactly match the
characters in string1. If found, return the index of the first
character in the last such match within string2. If there is no
match, then return -1.
string length string
Returns a decimal string giving the number of characters in string.
string match pattern string
See if pattern matches string; return 1 if it does, 0 if it doesn't.
Matching is done in a fashion similar to that used by the C-shell.
For the two strings to match, their contents must be identical
except that the following special sequences may appear in pattern:
* Matches any sequence of characters in string, including a
null string.
? Matches any single character in string.
[chars] Matches any character in the set given by chars. If a
sequence of the form x-y appears in chars, then any
character between x and y, inclusive, will match.
Page 1
string(3Tcl) string(3Tcl)
\x Matches the single character x. This provides a way of
avoiding the special interpretation of the characters
*?[]\ in pattern.
string range string first last
Returns a range of consecutive characters from string, starting with
the character whose index is first and ending with the character
whose index is last. An index of 0 refers to the first character of
the string. Last may be end (or any abbreviation of it) to refer to
the last character of the string. If first is less than zero then
it is treated as if it were zero, and if last is greater than or
equal to the length of the string then it is treated as if it were
end. If first is greater than last then an empty string is
returned.
string tolower string
Returns a value equal to string except that all upper case letters
have been converted to lower case.
string toupper string
Returns a value equal to string except that all lower case letters
have been converted to upper case.
string trim string ?chars?
Returns a value equal to string except that any leading or trailing
characters from the set given by chars are removed. If chars is not
specified then white space is removed (spaces, tabs, newlines, and
carriage returns).
string trimleft string ?chars?
Returns a value equal to string except that any leading characters
from the set given by chars are removed. If chars is not specified
then white space is removed (spaces, tabs, newlines, and carriage
returns).
string trimright string ?chars?
Returns a value equal to string except that any trailing characters
from the set given by chars are removed. If chars is not specified
then white space is removed (spaces, tabs, newlines, and carriage
returns).
string wordend string index
Returns the index of the character just after the last one in the |
word containing character index of string. A word is considered to |
be any contiguous range of alphanumeric or underscore characters, or|
any single character other than these.
string wordstart string index
Returns the index of the first character in the word containing |
character index of string. A word is considered to be any |
contiguous range of alphanumeric or underscore characters, or any |
single character other than these.
Page 2
string(3Tcl) string(3Tcl)
case conversion, compare, index, match, pattern, string, word
string(3C) string(3C)
string: strcat, strdup, strncat, strcmp, strncmp, strcpy, strncpy,
strlen, strchr, strrchr, strpbrk, strspn, strcspn, strtok, strstr
strcasecmp, strncasecmp, index, rindex, strtok_r - string operations
#include <string.h>
char *strcat (char *s1, const char *s2);
char *strdup (const char *s1);
char *strncat (char *s1, const char *s2, size_t n);
int strcmp (const char *s1, const char *s2);
int strncmp (const char *s1, const char *s2, size_t n);
int strcasecmp (const char *s1, const char *s2);
int strncasecmp (const char *s1, const char *s2, size_t n);
char *strcpy (char *s1, const char *s2);
char *strncpy (char *s1, const char *s2, size_t n);
size_t strlen (const char *s);
char *strchr (const char *s, int c);
char *strrchr (const char *s, int c);
char *strpbrk (const char *s1, const char *s2);
size_t strspn (const char *s1, const char *s2);
size_t strcspn (const char *s1, const char *s2);
char *strtok (char *s1, const char *s2);
char *strtok_r (char *s1, const char *s2, char **lasts);
char *strstr (const char *s1, const char *s2);
#include <strings.h>
char *index (const char *s, int c);
char *rindex (const char *s, int c);
Page 1
string(3C) string(3C)
The arguments s, s1, and s2 point to strings (arrays of characters
terminated by a null character). The functions strcat, strncat, strcpy,
strncpy, strtok_r, and strtok, all alter s1. These functions do not
check for overflow of the array pointed to by s1, or for overlap between
s1 and s2. If overflow of s1 occurs, or copying takes place when s1 and
s2 overlap, the behavior is undefined.
strcat appends a copy of string s2, including the terminating null
character, to the end of string s1. strncat appends at most n
characters. Each returns a pointer to the null-terminated result. The
initial character of s2 overrides the null character at the end of s1.
strcmp compares its arguments and returns an integer less than, equal to,
or greater than 0, based upon whether s1 is lexicographically less than,
equal to, or greater than s2. strncmp makes the same comparison but
looks at at most n characters. Characters following a null character are
not compared. strcasecmp and strncasecmp are case-insensitive versions
of strcmp and strncmp, respectively. Case-insensitive comparison is
implemented by converting upper-case ASCII characters to lower-case
before comparison. Thus strcasecmp and strncasecmp only give meaningful
results for the "C" locale (7 bit ASCII).
strcpy copies string s2 to s1 including the terminating null character,
stopping after the null character has been copied. strncpy copies
exactly n characters, truncating s2 or adding null characters to s1 if
necessary (ie. if the length of n is greater than the length of s2 ).
The result will not be null-terminated if the length of s2 is n or more.
Each function returns s1.
strdup returns a pointer to a new string which is a duplicate of the
string pointed to by s1. The space for the new string is obtained using
malloc(3C). If the new string can not be created, a NULL pointer is
returned.
strlen returns the number of characters in s, not including the
terminating null character.
strchr (or strrchr) returns a pointer to the first (last) occurrence of c
(converted to a char) in string s, or a NULL pointer if c does not occur
in the string. The null character terminating a string is considered to
be part of the string.
index (rindex) are included as duplicates of strchr (strrchr) for
compatibility (see Notes).
strpbrk returns a pointer to the first occurrence in string s1 of any
character from string s2, or a NULL pointer if no character from s2
exists in s1.
Page 2
string(3C) string(3C)
strspn (or strcspn) returns the length of the initial segment of string
s1 which consists entirely of characters from (not from) string s2.
strtok considers the string s1 to consist of a sequence of zero or more
text tokens separated by spans of one or more characters from the
separator string s2. The first call (with pointer s1 specified) returns
a pointer to the first character of the first token, and will have
written a null character into s1 immediately following the returned
token. The function keeps track of its position in the string between
separate calls, so that subsequent calls (which must be made with the
first argument a NULL pointer) will work through the string s1
immediately following that token. In this way subsequent calls will work
through the string s1 until no tokens remain. The separator string s2
may be different from call to call. When no token remains in s1, a NULL
pointer is returned. Note that a string consisting entirely of nonseparator
characters is considered a single token. For example, if the
initial call to strtok is made with s1 pointing to a string consisting
entirely of non-separator characters, then the return value from strtok
will be the value of s1 passed to strtok.
strtok_r is a reentrant version of strtok. The current location in the
string is kept track of in lasts. On the first call to strtok_r, lasts
should be a pointer to a NULL pointer. It is kept updated on each
successive call to strtok_r to point into s1 directly after the null
character. lasts must not be changed between calls to strtok_r. The
feature test macro _SGI_REENTRANT_FUNCTIONS should be defined to make
this function visible.
strstr locates the first occurrence in string s1 of the sequence of
characters (excluding the terminating null character) in string s2.
strstr returns a pointer to the located string, or a null pointer if the
string is not found. If s2 points to a string with zero length (i.e., the
string ""), the function returns s1.
malloc(3C), memory(3C), setlocale(3C), strcoll(3C), strerror(3C),
strxfrm(3C).
All of these functions assume the default locale ``C.'' For some
locales, strxfrm should be applied to the strings before they are passed
to the functions.
Declarations for index and rindex are specifically omitted from
<string.h> due to possible naming conflicts. Instead, they are declared
in <strings.h>.
The index, rindex, strcasecmp, strncasecmp routines are from the 4.3BSD
or 4.3BSD-tahoe standard C library.
PPPPaaaaggggeeee 3333 [ Back ]
|
