Kevux Git Server - fll/blob

   1 .TH fss_identify_print_error_parameter_file_name_empty "3" "January 2026" "FLL - FSS Identify 0.8.0" "Program Functions"
   2 .SH "NAME"
   3 fss_identify_print_error_parameter_file_name_empty \-
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <error.h>
   7 .sp
   8 \fBf_status_t fss_identify_print_error_parameter_file_name_empty\fP(
   9     \fBfl_print_t *const         \fP\fIprint\fP,
  10     \fBconst f_number_unsigned_t \fP\fIindex\fP
  11 );
  12 .fi
  13 .SH DESCRIPTION
  14 .PP
  15 Print error message for when the file parameter is an empty string.
  16 .PP
  17 F_output_not (with error bit) if setting is NULL.
  18 .SH PARAMETERS
  19 .TP
  20 .B print
  21 The output structure to print to.
  22
  23 .TP
  24 .B index
  25 The index within the argv[] array where the empty string is found.
  26
  27 .SH STRUCTURES
  28 .SS ""
  29 .PP
  30 .sp
  31 .PP
  32 Structure for facilitating colored or other managed printing.
  33 .PP
  34 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
  35 .sp
  36 .RS
  37 .nf
  38 \fB
  39 struct fl_print_t {
  40   f_file_t                \fIto\fP;
  41   uint8_t                 \fIverbosity\fP;
  42   uint64_t                \fIflag\fP;
  43   f_string_static_t       \fIprefix\fP;
  44   f_string_static_t       \fIsuffix\fP;
  45   f_color_set_t           \fIcontext\fP;
  46   f_color_set_t           \fInotable\fP;
  47   f_color_set_context_t  *\fIset\fP;
  48   void                   *\fIcustom\fP;
  49 };
  50 \fP
  51 .fi
  52 .RE
  53 .SH RETURN VALUE
  54 .PP
  55 F_okay on success. F_output_not on success, but no printing is performed.
  56 .SH SEE ALSO
  57 .PP
  58 .nh
  59 .ad l
  60 \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
  61 .ad
  62 .hy
  63 .SH AUTHOR
  64 Written by Kevin Day.
  65 .SH COPYRIGHT
  66 .PP
  67 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.