Kevux Git Server - fll/blob

   1 .TH fll_program_print_error_parameter_must_specify_once "3" "January 2026" "FLL - Featureless Linux Library 0.8.0 - Level 2" "Library Functions"
   2 .SH "NAME"
   3 fll_program_print_error_parameter_must_specify_once \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <print.h>
   7 .sp
   8 \fBf_status_t fll_program_print_error_parameter_must_specify_once\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 );
  13 .fi
  14 .SH DESCRIPTION
  15 .PP
  16 Print message about parameter only being allowed to be used once.
  17 .PP
  18 This is only printed when verbosity is not set to quiet.
  19 .PP
  20 print.prefix: For the prefixing a string to the message (such as "ERROR:").
  21 .PP
  22 F_parameter (with error bit) if a parameter is invalid.
  23 .SH PARAMETERS
  24 .TP
  25 .B print
  26 The output structure. This locks, uses, and unlocks the file stream.
  27
  28 .TP
  29 .B symbol
  30 The symbol string prepended to the parameter. This locks, uses, and unlocks the file stream. This is usually f_console_symbol_long_normal_s.
  31
  32 .TP
  33 .B name
  34 The parameter name.
  35
  36 .SH STRUCTURES
  37 .SS ""
  38 .PP
  39 .sp
  40 .PP
  41 Structure for facilitating colored or other managed printing.
  42 .PP
  43 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  44 .sp
  45 .RS
  46 .nf
  47 \fB
  48 struct fl_print_t {
  49   f_file_t                \fIto\fP;
  50   uint8_t                 \fIverbosity\fP;
  51   uint64_t                \fIflag\fP;
  52   f_string_static_t       \fIprefix\fP;
  53   f_string_static_t       \fIsuffix\fP;
  54   f_color_set_t           \fIcontext\fP;
  55   f_color_set_t           \fInotable\fP;
  56   f_color_set_context_t  *\fIset\fP;
  57   void                   *\fIcustom\fP;
  58 };
  59 \fP
  60 .fi
  61 .RE
  62 .SS ""
  63 .PP
  64 .sp
  65 .PP
  66 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  67 .PP
  68 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.
  69 .PP
  70 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.
  71 .PP
  72 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.
  73 .PP
  74 size: Total amount of space available.
  75 .sp
  76 .RS
  77 .nf
  78 \fB
  79 struct f_string_static_t {
  80   f_string_t          \fIstring\fP;
  81   f_number_unsigned_t \fIused\fP;
  82   f_number_unsigned_t \fIsize\fP;
  83 };
  84 \fP
  85 .fi
  86 .RE
  87 .SS ""
  88 .PP
  89 .sp
  90 .PP
  91 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  92 .PP
  93 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.
  94 .PP
  95 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.
  96 .PP
  97 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.
  98 .PP
  99 size: Total amount of space available.
 100 .sp
 101 .RS
 102 .nf
 103 \fB
 104 struct f_string_static_t {
 105   f_string_t          \fIstring\fP;
 106   f_number_unsigned_t \fIused\fP;
 107   f_number_unsigned_t \fIsize\fP;
 108 };
 109 \fP
 110 .fi
 111 .RE
 112 .SH RETURN VALUE
 113 .PP
 114 F_okay on success. F_output_not on success, but no printing is performed.
 115 .SH SEE ALSO
 116 .PP
 117 .nh
 118 .ad l
 119 \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)
 120 .ad
 121 .hy
 122 .SH AUTHOR
 123 Written by Kevin Day.
 124 .SH COPYRIGHT
 125 .PP
 126 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.