pd.if.org Git - pdclib/blob - man3/string.h.3

   1 .\" This file is part of the Public Domain C Library (PDCLib).
   2 .\" Permission is granted to use" "modify" "and / or redistribute at will.
   3 .\"
   4 .Dd
   5 .Dt STRING.H 3
   6 .Os
   7 .\"
   8 .Sh NAME
   9 .Nm string.h
  10 .Nd byte string manipulation
  11 .\"
  12 .Sh SYNOPSIS
  13 .In string.h
  14 .\"
  15 .Sh DESCRIPTION
  16 The
  17 .In string.h
  18 header provides byte string manipulation operations.
  19 .\"
  20 .Pp
  21 The type
  22 .Vt size_t ,
  23 and the preprocessor constant
  24 .Dv NULL
  25 shall be defined.
  26 .\"
  27 .Pp
  28 The following shall be defined as functions:
  29 .br
  30 .Fn "void *memcpy" "void *restrict dest" "const void *restrict src" "size_t byteCount"
  31 .br
  32 .Fn "void *memmove" "void *dest" "void *src" "size_t byteCount"
  33 .br
  34 .Fn "char *strcpy" "char *restrict dest" "const char *restrict src"
  35 .br
  36 .Fn "char *strncpy" "char *restrict dest" "const char *src" "size_t byteCount"
  37 .br
  38 .Fn "char *strcat" "char *restrict s1" "const char *restrict s2"
  39 .br
  40 .Fn "char *strncat" "char *restrict s1" "const char *restrict s2" "size_t n"
  41 .br
  42 .Fn "int memcmp" "const void *s1" "const void *s2" "size_t n"
  43 .br
  44 .Fn "int strcmp" "const char *s1" "const char *s2"
  45 .br
  46 .Fn "int strcoll" "const char *s1" "const char *s2"
  47 .br
  48 .Fn "int strncmp" "const char *s1" "const char *s2" "size_t n"
  49 .br
  50 .Fn "size_t strxfrm" "char *restrict s1" "const char *restrict s2" "size_t n"
  51 .br
  52 .Fn "void *memchr" "const void *s" "int c" "size_t n"
  53 .br
  54 .Fn "char *strchr" "const char *s" "int c"
  55 .br
  56 .Fn "size_t strcspn" "const char *s1" "const char *s2"
  57 .br
  58 .Fn "char *strpbrk" "const char *s1" "const char *s2"
  59 .br
  60 .Fn "char *strrchr" "const char *s" "int c"
  61 .br
  62 .Fn "size_t strspn" "const char *s1" "const char *s2"
  63 .br
  64 .Fn "char *strstr" "const char *s1" "const char *s2"
  65 .br
  66 .Fn "char *strtok" "char *restrict s1" "const char *restrict s2"
  67 .br
  68 .Fn "void *memset" "void *s" "int c" "size_t n"
  69 .br
  70 .Fn "char *strerror" "int errnum"
  71 .br
  72 .Fn "size_t strlen" "const char *s"
  73 .\"
  74 .Pp
  75 .Sy #define _XOPEN_SOURCE || _POSIX_C_SOURCE >= 200809L
  76 .br
  77 .Fn "char *strdup" "const char*src"
  78 .\"
  79 .Pp
  80 .Sy #define _POSIX_C_SOURCE >= 200809L
  81 .br
  82 .Fn "char *strndup" "const char*src" "size_t n"
  83 .\"
  84 .Sh SEE ALSO
  85 .Xr wchar.h 3
  86 .Xr stdlib.h 3
  87 .Xr memcpy 3
  88 .Xr memmove 3
  89 .Xr strcpy 3
  90 .Xr strncpy 3
  91 .Xr strcat 3
  92 .Xr strncat 3
  93 .Xr memcmp 3
  94 .Xr strcmp 3
  95 .Xr strcoll 3
  96 .Xr strncmp 3
  97 .Xr strxfrm 3
  98 .Xr memchr 3
  99 .Xr strchr 3
 100 .Xr strcspn 3
 101 .Xr strpbrk 3
 102 .Xr strrchr 3
 103 .Xr strspn 3
 104 .Xr strstr 3
 105 .Xr strtok 3
 106 .Xr memset 3
 107 .Xr strerror 3
 108 .Xr strlen 3
 109 .Xr strdup 3
 110 .Xr strndup 3
 111 .Sh STANDARDS
 112 Conforming to
 113 .St -isoC-90 ,
 114 .St -isoC-99 .