xref: /illumos-gate/usr/src/man/man3c/memory.3c (revision f6ed5ca267d42d2a060f8447acdeb647ef077b6d)
te
Copyright (c) 2014, Joyent, Inc.
Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
Copyright 1989 AT&T
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.
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.
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]
MEMORY 3C "Feb 4, 2009"
NAME
memory, memccpy, memchr, memcmp, memcpy, memmem, memmove, memset - memory operations
SYNOPSIS

#include <string.h>

void *memccpy(void *restrict s1, const void *restrict s2,
 int c, size_t n);

void *memchr(const void *s, int c, size_t n);

int memcmp(const void *s1, const void *s2, size_t n);

void *memcpy(void *restrict s1, const void *restrict s2, size_t n);

void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);

void *memmove(void *s1, const void *s2, size_t n);

void *memset(void *s, int c, size_t n);
"ISO C++"

#include <string.h>

const void *memchr(const void *s, int c, size_t n);

#include <cstring>

void *std::memchr(void *s, int c, size_t n);
DESCRIPTION

These functions operate as efficiently as possible on memory areas (arrays of bytes bounded by a count, not terminated by a null character). They do not check for the overflow of any receiving memory area.

The memccpy() function copies bytes from memory area s2 into s1, stopping after the first occurrence of c (converted to an unsigned char) has been copied, or after n bytes have been copied, whichever comes first. It returns a pointer to the byte after the copy of c in s1, or a null pointer if c was not found in the first n bytes of s2.

The memchr() function returns a pointer to the first occurrence of c (converted to an unsigned char) in the first n bytes (each interpreted as an unsigned char) of memory area s, or a null pointer if c does not occur.

The memcmp() function compares its arguments, looking at the first n bytes (each interpreted as an unsigned char), and returns an integer less than, equal to, or greater than 0, according as s1 is lexicographically less than, equal to, or greater than s2 when taken to be unsigned characters.

The memcpy() function copies n bytes from memory area s2 to s1. It returns s1. If copying takes place between objects that overlap, the behavior is undefined.

The memmem() function searches for the s_len long byte pattern s in the memory region starting at l for \fl_len bytes. If a match is found, a pointer to the starting location in l is returned. If no match is found, l_len is zero, s_len is zero, or l_len is less than s_len, then a null pointer is return.

The memmove() function copies n bytes from memory area s2 to memory area s1. Copying between objects that overlap will take place correctly. It returns s1.

The memset() function sets the first n bytes in memory area s to the value of c (converted to an unsigned char). It returns s.

USAGE

Using memcpy() might be faster than using memmove() if the application knows that the objects being copied do not overlap.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Stable
MT-Level MT-Safe
Standard See standards(5).
SEE ALSO

string(3C), attributes(5), standards(5)

NOTES

Overlap between objects being copied can arise even when their (virtual) address ranges appear to be disjoint; for example, as a result of memory-mapping overlapping portions of the same underlying file, or of attaching the same shared memory segment more than once.