Kevux Git Server - fll/blob

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