Kevux Git Server - fll/blob

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