lib/libc/string/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.4.2.2 2001/12/14 18:33:59 ru Exp $
  34 .\" $DragonFly: src/lib/libc/string/memccpy.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt MEMCCPY 3
  38 .Os
  39 .Sh NAME
  40 .Nm memccpy
  41 .Nd copy string until character found
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft void *
  47 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
  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 len
  67 bytes are copied, and a NULL pointer is returned.
  68 .Sh SEE ALSO
  69 .Xr bcopy 3 ,
  70 .Xr memcpy 3 ,
  71 .Xr memmove 3 ,
  72 .Xr strcpy 3
  73 .Sh HISTORY
  74 The
  75 .Fn memccpy
  76 function first appeared in
  77 .Bx 4.4 .