Kevux Git Server - fll/blob

   1 .TH fss_read_print_error_parameter_value_before_value_number "3" "January 2026" "FLL - FSS Read 0.8.0" "Program Functions"
   2 .SH "NAME"
   3 fss_read_print_error_parameter_value_before_value_number \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <error.h>
   7 .sp
   8 \fBf_status_t fss_read_print_error_parameter_value_before_value_number\fP(
   9     \fBfl_print_t *const         \fP\fIprint\fP,
  10     \fBconst f_string_static_t   \fP\fIsymbol\fP,
  11     \fBconst f_string_static_t   \fP\fIname\fP,
  12     \fBconst f_number_unsigned_t \fP\fIvalue\fP,
  13     \fBconst f_number_unsigned_t \fP\fIbefore\fP
  14 );
  15 .fi
  16 .SH DESCRIPTION
  17 .PP
  18 Print an error message about the parameter not allowing a value before another value.
  19 .PP
  20 The print.custom is expected to be of type fss_read_main_t.
  21 .PP
  22 F_output_not (with error bit) if a parameter is NULL.
  23 .SH PARAMETERS
  24 .TP
  25 .B print
  26 The output structure to print to.
  27
  28 .TP
  29 .B symbol
  30 The symbol string prepended to the first parameter. This is usually f_console_symbol_long_normal_s.
  31
  32 .TP
  33 .B name
  34 The parameter name.
  35
  36 .TP
  37 .B value
  38 The parameter value that cannot be specified before the "before" function parameter.
  39
  40 .TP
  41 .B before
  42 The parameter value that is before the "value" function parameter.
  43
  44 .SH STRUCTURES
  45 .SS ""
  46 .PP
  47 .sp
  48 .PP
  49 Structure for facilitating colored or other managed printing.
  50 .PP
  51 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  52 .sp
  53 .RS
  54 .nf
  55 \fB
  56 struct fl_print_t {
  57   f_file_t                \fIto\fP;
  58   uint8_t                 \fIverbosity\fP;
  59   uint64_t                \fIflag\fP;
  60   f_string_static_t       \fIprefix\fP;
  61   f_string_static_t       \fIsuffix\fP;
  62   f_color_set_t           \fIcontext\fP;
  63   f_color_set_t           \fInotable\fP;
  64   f_color_set_context_t  *\fIset\fP;
  65   void                   *\fIcustom\fP;
  66 };
  67 \fP
  68 .fi
  69 .RE
  70 .SS ""
  71 .PP
  72 .sp
  73 .PP
  74 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  75 .PP
  76 The f_string_static_t type should always have size set to 0 to represent that it is a static string. This allows for easier integration with f_string_dynamic_t.
  77 .PP
  78 If size is set to some value other than 0 for a static string, then take special care not to intermix it with f_string_dynamic_t.
  79 .PP
  80 A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size.
  81 .PP
  82 size: Total amount of space available.
  83 .sp
  84 .RS
  85 .nf
  86 \fB
  87 struct f_string_static_t {
  88   f_string_t          \fIstring\fP;
  89   f_number_unsigned_t \fIused\fP;
  90   f_number_unsigned_t \fIsize\fP;
  91 };
  92 \fP
  93 .fi
  94 .RE
  95 .SS ""
  96 .PP
  97 .sp
  98 .PP
  99 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 100 .PP
 101 The f_string_static_t type should always have size set to 0 to represent that it is a static string. This allows for easier integration with f_string_dynamic_t.
 102 .PP
 103 If size is set to some value other than 0 for a static string, then take special care not to intermix it with f_string_dynamic_t.
 104 .PP
 105 A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size.
 106 .PP
 107 size: Total amount of space available.
 108 .sp
 109 .RS
 110 .nf
 111 \fB
 112 struct f_string_static_t {
 113   f_string_t          \fIstring\fP;
 114   f_number_unsigned_t \fIused\fP;
 115   f_number_unsigned_t \fIsize\fP;
 116 };
 117 \fP
 118 .fi
 119 .RE
 120 .SH RETURN VALUE
 121 .PP
 122 F_okay on success. F_output_not on success, but no printing is performed.
 123 .SH SEE ALSO
 124 .PP
 125 .nh
 126 .ad l
 127 \fIerror.h\fP(3), \fIfss_read_print_error\fP(3), \fIfss_read_print_error_file\fP(3), \fIfss_read_print_error_fss_end_early\fP(3), \fIfss_read_print_error_fss_read\fP(3), \fIfss_read_print_error_one_content_only\fP(3), \fIfss_read_print_error_parameter_requires_message\fP(3), \fIfss_read_print_error_parameter_value_before_value_number\fP(3), \fIfss_read_print_error_parameter_value_once_only_number\fP(3), \fIfss_read_print_error_unsupported_eol\fP(3), \fIfss_read_main_t\fP
 128 .ad
 129 .hy
 130 .SH AUTHOR
 131 Written by Kevin Day.
 132 .SH COPYRIGHT
 133 .PP
 134 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.