usr/src/man/man3gen/strfind.3gen

   1 '\" te
   2 .\"  Copyright 1989 AT&T Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STRFIND 3GEN "Jan 20, 1999"
   7 .SH NAME
   8 strfind, strrspn, strtrns, str \- string manipulations
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ]
  13 #include <libgen.h>
  14
  15 \fBint\fR \fBstrfind\fR(\fBconst char *\fR\fIas1\fR, \fBconst char *\fR\fIas2\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBchar *\fR\fBstrrspn\fR(\fBconst char *\fR\fIstring\fR, \fBconst char *\fR\fItc\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBchar *\fR \fBstrtrns\fR(\fBconst char *\fR\fIstring\fR, \fBconst char *\fR\fIold\fR, \fBconst char *\fR\fInew\fR,
  26      \fBchar *\fR\fIresult\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBstrfind()\fR function returns the offset of the first occurrence of the
  33 second string,  \fIas2\fR, if it is a substring of string \fIas1\fR. If the
  34 second string is not a substring of the first string \fBstrfind()\fR returns
  35 \fB\(mi1\fR\&.
  36 .sp
  37 .LP
  38 The \fBstrrspn()\fR function trims chartacters from a string. It searches from
  39 the end of \fIstring\fR for the first character that is not contained in
  40 \fItc\fR. If such a character is found, \fBstrrspn()\fR returns a pointer to
  41 the next character; otherwise, it returns a pointer to \fIstring\fR.
  42 .sp
  43 .LP
  44  The \fBstrtrns()\fR function transforms  \fIstring\fR and copies it into
  45 \fIresult\fR. Any character  that appears in  \fIold\fR is replaced with the
  46 character in the same position in  \fInew\fR. The  \fInew\fR result is
  47 returned.
  48 .SH USAGE
  49 .sp
  50 .LP
  51 When compiling multithreaded applications, the \fB_REENTRANT\fR flag must be
  52 defined on the compile line.  This flag should only be used in multithreaded
  53 applications.
  54 .SH EXAMPLES
  55 .LP
  56 \fBExample 1 \fRAn example of the \fBstrfind()\fR function.
  57 .sp
  58 .in +2
  59 .nf
  60 \fB/* find offset to substring "hello" within as1 */
  61 i = strfind(as1, "hello");
  62 /* trim junk from end of string */
  63 s2 = strrspn(s1, "*?#$%");
  64 *s2 = '\e0';
  65 /* transform lower case to upper case */
  66 a1[] = "abcdefghijklmnopqrstuvwxyz";
  67 a2[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
  68 s2 = strtrns(s1, a1, a2, s2);\fR
  69 .fi
  70 .in -2
  71 .sp
  72
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 MT-Level        MT-Safe
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBstring\fR(3C), \fBattributes\fR(5)