Kevux Git Server - fll/blob

   1 .TH fss_identify_print_error_parameter_file_name_invalid "3" "January 2026" "FLL - FSS Identify 0.8.0" "Program Functions"
   2 .SH "NAME"
   3 fss_identify_print_error_parameter_file_name_invalid \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <error.h>
   7 .sp
   8 \fBf_status_t fss_identify_print_error_parameter_file_name_invalid\fP(
   9     \fBfl_print_t *const         \fP\fIprint\fP,
  10     \fBconst f_number_unsigned_t \fP\fIindex\fP,
  11     \fBconst f_string_static_t   \fP\fIname\fP
  12 );
  13 .fi
  14 .SH DESCRIPTION
  15 .PP
  16 Print error message for when the file parameter is invalid.
  17 .PP
  18 F_output_not (with error bit) if setting is NULL.
  19 .SH PARAMETERS
  20 .TP
  21 .B print
  22 The output structure to print to.
  23
  24 .TP
  25 .B index
  26 The index within the argv[] array where the empty string is found.
  27
  28 .TP
  29 .B name
  30 The parameter name value string that is invalid.
  31
  32 .SH STRUCTURES
  33 .SS ""
  34 .PP
  35 .sp
  36 .PP
  37 Structure for facilitating colored or other managed printing.
  38 .PP
  39 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  40 .sp
  41 .RS
  42 .nf
  43 \fB
  44 struct fl_print_t {
  45   f_file_t                \fIto\fP;
  46   uint8_t                 \fIverbosity\fP;
  47   uint64_t                \fIflag\fP;
  48   f_string_static_t       \fIprefix\fP;
  49   f_string_static_t       \fIsuffix\fP;
  50   f_color_set_t           \fIcontext\fP;
  51   f_color_set_t           \fInotable\fP;
  52   f_color_set_context_t  *\fIset\fP;
  53   void                   *\fIcustom\fP;
  54 };
  55 \fP
  56 .fi
  57 .RE
  58 .SS ""
  59 .PP
  60 .sp
  61 .PP
  62 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
  63 .PP
  64 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.
  65 .PP
  66 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.
  67 .PP
  68 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.
  69 .PP
  70 size: Total amount of space available.
  71 .sp
  72 .RS
  73 .nf
  74 \fB
  75 struct f_string_static_t {
  76   f_string_t          \fIstring\fP;
  77   f_number_unsigned_t \fIused\fP;
  78   f_number_unsigned_t \fIsize\fP;
  79 };
  80 \fP
  81 .fi
  82 .RE
  83 .SH RETURN VALUE
  84 .PP
  85 F_okay on success. F_output_not on success, but no printing is performed.
  86 .SH SEE ALSO
  87 .PP
  88 .nh
  89 .ad l
  90 \fIerror.h\fP(3), \fIfss_identify_print_error\fP(3), \fIfss_identify_print_error_file\fP(3), \fIfss_identify_print_error_no_from\fP(3), \fIfss_identify_print_error_parameter_file_name_empty\fP(3), \fIfss_identify_print_error_parameter_file_name_invalid\fP(3), \fIf_file_stream_lock()\fP, \fIf_file_stream_unlock()\fP, \fIfl_print_format()\fP
  91 .ad
  92 .hy
  93 .SH AUTHOR
  94 Written by Kevin Day.
  95 .SH COPYRIGHT
  96 .PP
  97 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.