Kevux Git Server - fll/blob

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