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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)memccpy.3   8.1 (Berkeley) 6/9/93
  29 .\" $FreeBSD: src/lib/libc/string/memccpy.3,v 1.7 2007/01/09 00:28:12 imp Exp $
  30 .\"
  31 .Dd June 9, 1993
  32 .Dt MEMCCPY 3
  33 .Os
  34 .Sh NAME
  35 .Nm memccpy
  36 .Nd copy string until character found
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In string.h
  41 .Ft void *
  42 .Fo memccpy
  43 .Fa "void *restrict dst"
  44 .Fa "const void *restrict src"
  45 .Fa "int c"
  46 .Fa "size_t n"
  47 .Fc
  48 .Sh DESCRIPTION
  49 The
  50 .Fn memccpy
  51 function
  52 copies bytes from string
  53 .Fa src
  54 to string
  55 .Fa dst .
  56 If the character
  57 .Fa c
  58 (as converted to an unsigned char) occurs in the string
  59 .Fa src ,
  60 the copy stops and a pointer to the byte after the copy of
  61 .Fa c
  62 in the string
  63 .Fa dst
  64 is returned.
  65 Otherwise,
  66 .Fa n
  67 bytes are copied, and a NULL pointer is returned.
  68 .Pp
  69 The source and destination strings should not overlap, as the
  70 behavior is undefined.
  71 .Sh SEE ALSO
  72 .Xr bcopy 3 ,
  73 .Xr memcpy 3 ,
  74 .Xr memmove 3 ,
  75 .Xr strcpy 3
  76 .Sh HISTORY
  77 The
  78 .Fn memccpy
  79 function first appeared in
  80 .Bx 4.4 .