string/FreeBSD/memccpy.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)memccpy.3   8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/string/memccpy.3,v 1.6 2001/10/01 16:09:00 ru Exp $
  34 .\"
  35 .Dd June 9, 1993
  36 .Dt MEMCCPY 3
  37 .Os
  38 .Sh NAME
  39 .Nm memccpy
  40 .Nd copy string until character found
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In string.h
  45 .Ft void *
  46 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn memccpy
  50 function
  51 copies bytes from string
  52 .Fa src
  53 to string
  54 .Fa dst .
  55 If the character
  56 .Fa c
  57 (as converted to an unsigned char) occurs in the string
  58 .Fa src ,
  59 the copy stops and a pointer to the byte after the copy of
  60 .Fa c
  61 in the string
  62 .Fa dst
  63 is returned.
  64 Otherwise,
  65 .Fa len
  66 bytes are copied, and a NULL pointer is returned.
  67 .Sh SEE ALSO
  68 .Xr bcopy 3 ,
  69 .Xr memcpy 3 ,
  70 .Xr memmove 3 ,
  71 .Xr strcpy 3
  72 .Sh HISTORY
  73 The
  74 .Fn memccpy
  75 function first appeared in
  76 .Bx 4.4 .