Kevux Git Server - fll/blob

   1 .TH fl_string_dynamic_partial_compare_except_trim_string "3" "July 2023" "FLL - Featureless Linux Library 0.6.7" "Library Functions"
   2 .SH "NAME"
   3 fl_string_dynamic_partial_compare_except_trim_string
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <fll/level_1/string.h>
   7 .sp
   8 \fBf_status_t fl_string_dynamic_partial_compare_except_trim_string\fP(
   9     \fBconst f_string_t        \fP\fIstring1\fP,
  10     \fBconst f_string_static_t \fP\fIstring2\fP,
  11     \fBconst f_array_length_t  \fP\fIlength1\fP,
  12     \fBconst f_string_range_t  \fP\fIrange2\fP,
  13     \fBconst f_array_lengths_t \fP\fIexcept1\fP,
  14     \fBconst f_array_lengths_t \fP\fIexcept2\fP
  15 );
  16 .fi
  17 .SH DESCRIPTION
  18 .PP
  19 Compare two strings, similar to strncmp(), but restricted to the given range for the second string.
  20 .PP
  21 This operates with the first string being a traditional string.
  22 .PP
  23 This does not stop on NULL. NULL characters are ignored. Ignores leading and trailing whitespace. All 1-byte characters in except1 and except2 are ignored.
  24 .SH PARAMETERS
  25 .TP
  26 .B string1
  27 String to compare.
  28
  29 .TP
  30 .B string2
  31 String to compare.
  32
  33 .TP
  34 .B length1
  35 The length of string1.
  36
  37 .TP
  38 .B range2
  39 A range within the string2 to restrict the comparison to.
  40
  41 .TP
  42 .B except1
  43 A set of locations within string1 to ignore. This assumes/requires that the locations be in linear order.
  44
  45 .TP
  46 .B except2
  47 A set of locations within string2 to ignore. This assumes/requires that the locations be in linear order.
  48
  49 .SH RETURN VALUE
  50 .PP
  51 \fBF_equal_to\fP when both strings equal.
  52 .br
  53 \fBF_equal_to_not\fP when both strings do not equal.
  54 .br
  55 \fBF_parameter\fP (with error bit) if a parameter is invalid.
  56 .br
  57 \fBF_parameter\fP (with error bit) from: f_utf_is_combining().
  58 .br
  59 \fBF_parameter\fP (with error bit) from: f_utf_is_whitespace().
  60 .SH AUTHOR
  61 Written by Kevin Day.
  62 .SH COPYRIGHT
  63 .PP
  64 Copyright \(co 2007-2023 Kevin Day, GNU LGPL Version 2.1 or later.