home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3c / catmsgfmt.z / catmsgfmt
Encoding:
Text File  |  2002-10-03  |  5.2 KB  |  67 lines
  1.  
  2.  
  3.  
  4. ccccaaaattttmmmmssssggggffffmmmmtttt((((3333CCCC))))                                                    ccccaaaattttmmmmssssggggffffmmmmtttt((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      catmsgfmt - formats an error message
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      fixed: .nf _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_nnnn_llll______tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.  
  14.      _cccc_hhhh_aaaa_rrrr _****_cccc_aaaa_tttt_mmmm_ssss_gggg_ffff_mmmm_tttt _((((_cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_c_m_d_n_a_m_e_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_g_r_o_u_p_c_o_d_e_,,,, _iiii_nnnn_tttt _m_s_g_n_u_m_,,,,
  15.      _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_s_e_v_e_r_i_t_y_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_m_s_g_t_e_x_t_,,,, _cccc_hhhh_aaaa_rrrr _****_b_u_f_,,,, _iiii_nnnn_tttt _b_u_f_l_e_n_,,,,
  16.      _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_p_o_s_i_t_i_o_n_,,,, _cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_d_e_b_u_g_))))_;;;;
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      The _cccc_aaaa_tttt_mmmm_ssss_gggg_ffff_mmmm_tttt function produces a formatted message that consists of the
  20.      command name (_c_m_d_n_a_m_e), group code (_g_r_o_u_p_c_o_d_e), message number (_m_s_g_n_u_m),
  21.      severity level (_s_e_v_e_r_i_t_y), message text (_m_s_g_t_e_x_t), and optional position
  22.      (_p_o_s_i_t_i_o_n) and debugging (_d_e_b_u_g) information.  The formatted message is
  23.      placed in the user-supplied buffer, which is pointed to by _b_u_f, and
  24.      terminated with a null byte.  If the formatted message is longer than
  25.      _b_u_f_l_e_n bytes, it is truncated to _b_u_f_l_e_n bytes with a null byte.
  26.  
  27.      The _c_m_d_n_a_m_e, _g_r_o_u_p_c_o_d_e, _s_e_v_e_r_i_t_y, _m_s_g_t_e_x_t, and optional _p_o_s_i_t_i_o_n and
  28.      _d_e_b_u_g arguments are null-terminated strings.  The command name identifies
  29.      the command or function issuing the error message.  Typically, the group
  30.      code is the same value as that specified as the _n_a_m_e parameter on the
  31.      _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn(3C) function.  Typically, the message number is the same value as
  32.      that specified on the _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg(3C) or _cccc_aaaa_tttt_gggg_eeee_tttt_ssss(3C) function.
  33.  
  34.      The _p_o_s_i_t_i_o_n and _d_e_b_u_g arguments are optional.  Their contents are
  35.      inserted in the error message only if provided and only if included in
  36.      the _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT environment variable.  Specifying a null value for either
  37.      (or both) parameters is equivalent to not specifying either (or both)
  38.      parameters.
  39.  
  40. NNNNOOOOTTTTEEEESSSS
  41.      The _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT environment variable controls the formatting of the
  42.      message.  If the _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT environment variable is not defined, a
  43.      default format is used.  See the _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn(1) man page for a description of
  44.      message formats and the _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT environment variable.
  45.  
  46.      _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT can include an optional time stamp for the message.  The
  47.      format of this time stamp is equivalent to that produced by the
  48.      _cccc_ffff_tttt_iiii_mmmm_eeee(3C) function and can be overridden by the _CCCC_FFFF_TTTT_IIII_MMMM_EEEE environment
  49.      variable.  For a description of time-stamp formats, see the _ssss_tttt_rrrr_ffff_tttt_iiii_mmmm_eeee(3C)
  50.      man page.
  51.  
  52. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  53.      If successful, _cccc_aaaa_tttt_mmmm_ssss_gggg_ffff_mmmm_tttt returns a pointer to the user-supplied buffer.
  54.      If unsuccessful, it returns a null pointer.
  55.  
  56. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  57.      caterr(1), explain(1), gencat(1), whichcat(1), catgetmsg(3C),
  58.      catgets(3C), catopen(3C), strftime(3C), nl_types(5).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.