Kevux Git Server - fll/blob

   1 .TH fll_program_print_error_parameter_cannot_use_with_without "3" "January 2026" "FLL - Featureless Linux Library 0.8.0 - Level 2" "Library Functions"
   2 .SH "NAME"
   3 fll_program_print_error_parameter_cannot_use_with_without \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <print.h>
   7 .sp
   8 \fBf_status_t fll_program_print_error_parameter_cannot_use_with_without\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\fIsymbol_3\fP,
  13     \fBconst f_string_static_t \fP\fIname_1\fP,
  14     \fBconst f_string_static_t \fP\fIname_2\fP,
  15     \fBconst f_string_static_t \fP\fIname_3\fP
  16 );
  17 .fi
  18 .SH DESCRIPTION
  19 .PP
  20 Print message about two parameters not being allowed to be used together when a third is not used.
  21 .PP
  22 This is only printed when verbosity is not set to quiet.
  23 .PP
  24 print.prefix: For the prefixing a string to the message (such as "ERROR:").
  25 .PP
  26 F_parameter (with error bit) if a parameter is invalid.
  27 .SH PARAMETERS
  28 .TP
  29 .B print
  30 The output structure. This locks, uses, and unlocks the file stream.
  31
  32 .TP
  33 .B symbol_1
  34 The symbol string prepended to the first parameter. This is usually f_console_symbol_long_normal_s.
  35
  36 .TP
  37 .B symbol_2
  38 The symbol string prepended to the second parameter. This is usually f_console_symbol_long_normal_s.
  39
  40 .TP
  41 .B symbol_3
  42 The symbol string prepended to the second parameter. This is usually f_console_symbol_long_normal_s.
  43
  44 .TP
  45 .B name_1
  46 The first parameter name (the parameter that cannot be used with the second parameter).
  47
  48 .TP
  49 .B name_2
  50 The second parameter name.
  51
  52 .TP
  53 .B name_3
  54 The third parameter name (the without parameter).
  55
  56 .SH STRUCTURES
  57 .SS ""
  58 .PP
  59 .sp
  60 .PP
  61 Structure for facilitating colored or other managed printing.
  62 .PP
  63 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  64 .sp
  65 .RS
  66 .nf
  67 \fB
  68 struct fl_print_t {
  69   f_file_t                \fIto\fP;
  70   uint8_t                 \fIverbosity\fP;
  71   uint64_t                \fIflag\fP;
  72   f_string_static_t       \fIprefix\fP;
  73   f_string_static_t       \fIsuffix\fP;
  74   f_color_set_t           \fIcontext\fP;
  75   f_color_set_t           \fInotable\fP;
  76   f_color_set_context_t  *\fIset\fP;
  77   void                   *\fIcustom\fP;
  78 };
  79 \fP
  80 .fi
  81 .RE
  82 .SS ""
  83 .PP
  84 .sp
  85 .PP
  86 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  87 .PP
  88 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.
  89 .PP
  90 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.
  91 .PP
  92 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.
  93 .PP
  94 size: Total amount of space available.
  95 .sp
  96 .RS
  97 .nf
  98 \fB
  99 struct f_string_static_t {
 100   f_string_t          \fIstring\fP;
 101   f_number_unsigned_t \fIused\fP;
 102   f_number_unsigned_t \fIsize\fP;
 103 };
 104 \fP
 105 .fi
 106 .RE
 107 .SS ""
 108 .PP
 109 .sp
 110 .PP
 111 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 112 .PP
 113 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.
 114 .PP
 115 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.
 116 .PP
 117 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.
 118 .PP
 119 size: Total amount of space available.
 120 .sp
 121 .RS
 122 .nf
 123 \fB
 124 struct f_string_static_t {
 125   f_string_t          \fIstring\fP;
 126   f_number_unsigned_t \fIused\fP;
 127   f_number_unsigned_t \fIsize\fP;
 128 };
 129 \fP
 130 .fi
 131 .RE
 132 .SS ""
 133 .PP
 134 .sp
 135 .PP
 136 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 137 .PP
 138 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.
 139 .PP
 140 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.
 141 .PP
 142 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.
 143 .PP
 144 size: Total amount of space available.
 145 .sp
 146 .RS
 147 .nf
 148 \fB
 149 struct f_string_static_t {
 150   f_string_t          \fIstring\fP;
 151   f_number_unsigned_t \fIused\fP;
 152   f_number_unsigned_t \fIsize\fP;
 153 };
 154 \fP
 155 .fi
 156 .RE
 157 .SS ""
 158 .PP
 159 .sp
 160 .PP
 161 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 162 .PP
 163 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.
 164 .PP
 165 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.
 166 .PP
 167 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.
 168 .PP
 169 size: Total amount of space available.
 170 .sp
 171 .RS
 172 .nf
 173 \fB
 174 struct f_string_static_t {
 175   f_string_t          \fIstring\fP;
 176   f_number_unsigned_t \fIused\fP;
 177   f_number_unsigned_t \fIsize\fP;
 178 };
 179 \fP
 180 .fi
 181 .RE
 182 .SS ""
 183 .PP
 184 .sp
 185 .PP
 186 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 187 .PP
 188 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.
 189 .PP
 190 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.
 191 .PP
 192 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.
 193 .PP
 194 size: Total amount of space available.
 195 .sp
 196 .RS
 197 .nf
 198 \fB
 199 struct f_string_static_t {
 200   f_string_t          \fIstring\fP;
 201   f_number_unsigned_t \fIused\fP;
 202   f_number_unsigned_t \fIsize\fP;
 203 };
 204 \fP
 205 .fi
 206 .RE
 207 .SS ""
 208 .PP
 209 .sp
 210 .PP
 211 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
 212 .PP
 213 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.
 214 .PP
 215 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.
 216 .PP
 217 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.
 218 .PP
 219 size: Total amount of space available.
 220 .sp
 221 .RS
 222 .nf
 223 \fB
 224 struct f_string_static_t {
 225   f_string_t          \fIstring\fP;
 226   f_number_unsigned_t \fIused\fP;
 227   f_number_unsigned_t \fIsize\fP;
 228 };
 229 \fP
 230 .fi
 231 .RE
 232 .SH RETURN VALUE
 233 .PP
 234 F_okay on success. F_output_not on success, but no printing is performed.
 235 .SH SEE ALSO
 236 .PP
 237 .nh
 238 .ad l
 239 \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)
 240 .ad
 241 .hy
 242 .SH AUTHOR
 243 Written by Kevin Day.
 244 .SH COPYRIGHT
 245 .PP
 246 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.