Kevux Git Server - fll/blob

   1 .TH fll_program_print_error_parameter_both_specified_same_amount "3" "January 2026" "FLL - Featureless Linux Library 0.8.0 - Level 2" "Library Functions"
   2 .SH "NAME"
   3 fll_program_print_error_parameter_both_specified_same_amount \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <print.h>
   7 .sp
   8 \fBf_status_t fll_program_print_error_parameter_both_specified_same_amount\fP(
   9     \fBfl_print_t *const       \fP\fIprint\fP,
  10     \fBconst f_string_static_t \fP\fIsymbol_1\fP,
  11     \fBconst f_string_static_t \fP\fIsymbol_2\fP,
  12     \fBconst f_string_static_t \fP\fIname_1\fP,
  13     \fBconst f_string_static_t \fP\fIname_2\fP
  14 );
  15 .fi
  16 .SH DESCRIPTION
  17 .PP
  18 Print an error message about two parameters being required to be specified the same number of times.
  19 .PP
  20 This is only printed when verbosity is not set to quiet.
  21 .PP
  22 print.prefix: For the prefixing a string to the message (such as "ERROR:").
  23 .PP
  24 F_parameter (with error bit) if a parameter is invalid.
  25 .SH PARAMETERS
  26 .TP
  27 .B print
  28 The output structure. This locks, uses, and unlocks the file stream.
  29
  30 .TP
  31 .B symbol_1
  32 The symbol string prepended to the first parameter. This is usually f_console_symbol_long_normal_s.
  33
  34 .TP
  35 .B symbol_2
  36 The symbol string prepended to the second parameter. This is usually f_console_symbol_long_normal_s.
  37
  38 .TP
  39 .B name_1
  40 The first parameter name.
  41
  42 .TP
  43 .B name_2
  44 The second parameter name.
  45
  46 .SH STRUCTURES
  47 .SS ""
  48 .PP
  49 .sp
  50 .PP
  51 Structure for facilitating colored or other managed printing.
  52 .PP
  53 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  54 .sp
  55 .RS
  56 .nf
  57 \fB
  58 struct fl_print_t {
  59   f_file_t                \fIto\fP;
  60   uint8_t                 \fIverbosity\fP;
  61   uint64_t                \fIflag\fP;
  62   f_string_static_t       \fIprefix\fP;
  63   f_string_static_t       \fIsuffix\fP;
  64   f_color_set_t           \fIcontext\fP;
  65   f_color_set_t           \fInotable\fP;
  66   f_color_set_context_t  *\fIset\fP;
  67   void                   *\fIcustom\fP;
  68 };
  69 \fP
  70 .fi
  71 .RE
  72 .SS ""
  73 .PP
  74 .sp
  75 .PP
  76 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  77 .PP
  78 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.
  79 .PP
  80 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.
  81 .PP
  82 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.
  83 .PP
  84 size: Total amount of space available.
  85 .sp
  86 .RS
  87 .nf
  88 \fB
  89 struct f_string_static_t {
  90   f_string_t          \fIstring\fP;
  91   f_number_unsigned_t \fIused\fP;
  92   f_number_unsigned_t \fIsize\fP;
  93 };
  94 \fP
  95 .fi
  96 .RE
  97 .SS ""
  98 .PP
  99 .sp
 100 .PP
 101 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 102 .PP
 103 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.
 104 .PP
 105 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.
 106 .PP
 107 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.
 108 .PP
 109 size: Total amount of space available.
 110 .sp
 111 .RS
 112 .nf
 113 \fB
 114 struct f_string_static_t {
 115   f_string_t          \fIstring\fP;
 116   f_number_unsigned_t \fIused\fP;
 117   f_number_unsigned_t \fIsize\fP;
 118 };
 119 \fP
 120 .fi
 121 .RE
 122 .SS ""
 123 .PP
 124 .sp
 125 .PP
 126 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 127 .PP
 128 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.
 129 .PP
 130 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.
 131 .PP
 132 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.
 133 .PP
 134 size: Total amount of space available.
 135 .sp
 136 .RS
 137 .nf
 138 \fB
 139 struct f_string_static_t {
 140   f_string_t          \fIstring\fP;
 141   f_number_unsigned_t \fIused\fP;
 142   f_number_unsigned_t \fIsize\fP;
 143 };
 144 \fP
 145 .fi
 146 .RE
 147 .SS ""
 148 .PP
 149 .sp
 150 .PP
 151 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 152 .PP
 153 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.
 154 .PP
 155 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.
 156 .PP
 157 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.
 158 .PP
 159 size: Total amount of space available.
 160 .sp
 161 .RS
 162 .nf
 163 \fB
 164 struct f_string_static_t {
 165   f_string_t          \fIstring\fP;
 166   f_number_unsigned_t \fIused\fP;
 167   f_number_unsigned_t \fIsize\fP;
 168 };
 169 \fP
 170 .fi
 171 .RE
 172 .SH RETURN VALUE
 173 .PP
 174 F_okay on success. F_output_not on success, but no printing is performed.
 175 .SH SEE ALSO
 176 .PP
 177 .nh
 178 .ad l
 179 \fIprint.h\fP(3), \fIfll_program_print_copyright\fP(3), \fIfll_program_print_error_missing_file\fP(3), \fIfll_program_print_error_missing_variable_not_zero\fP(3), \fIfll_program_print_error_parameter_both_specified_same_amount\fP(3), \fIfll_program_print_error_parameter_both_specified_same_amount_without\fP(3), \fIfll_program_print_error_parameter_cannot_use_with\fP(3), \fIfll_program_print_error_parameter_cannot_use_with_pipe\fP(3), \fIfll_program_print_error_parameter_cannot_use_with_without\fP(3), \fIfll_program_print_error_parameter_cannot_use_with_xor\fP(3), \fIfll_program_print_error_parameter_empty_value\fP(3), \fIfll_program_print_error_parameter_integer_less_than\fP(3), \fIfll_program_print_error_parameter_integer_more_than\fP(3), \fIfll_program_print_error_parameter_integer_not\fP(3), \fIfll_program_print_error_parameter_integer_not_negative\fP(3), \fIfll_program_print_error_parameter_integer_not_positive\fP(3), \fIfll_program_print_error_parameter_missing_value\fP(3), \fIfll_program_print_error_parameter_missing_value_requires_amount\fP(3), \fIfll_program_print_error_parameter_must_specify_once\fP(3), \fIfll_program_print_error_parameter_must_specify_once_value\fP(3), \fIfll_program_print_error_parameter_process\fP(3), \fIfll_program_print_error_parameter_range_start_before_stop\fP(3), \fIfll_program_print_error_parameter_support_not\fP(3), \fIfll_program_print_error_parameter_too_few\fP(3), \fIfll_program_print_error_parameter_too_many\fP(3), \fIfll_program_print_error_parameter_value_too_long\fP(3), \fIfll_program_print_error_pipe_invalid_form_feed\fP(3), \fIfll_program_print_error_pipe_missing_content\fP(3), \fIfll_program_print_error_pipe_object_without_content\fP(3), \fIfll_program_print_help_header\fP(3), \fIfll_program_print_help_operations\fP(3), \fIfll_program_print_help_option\fP(3), \fIfll_program_print_help_option_long\fP(3), \fIfll_program_print_help_option_other\fP(3), \fIfll_program_print_help_option_short\fP(3), \fIfll_program_print_help_option_standard\fP(3), \fIfll_program_print_help_special_options\fP(3), \fIfll_program_print_help_usage\fP(3), \fIfll_program_print_signal_received\fP(3), \fIfll_program_print_version\fP(3)
 180 .ad
 181 .hy
 182 .SH AUTHOR
 183 Written by Kevin Day.
 184 .SH COPYRIGHT
 185 .PP
 186 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.