home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xtfindfile.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  3.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XtFindFile(3Xt)           XT FUNCTIONS          XtFindFile(3Xt)
  5.  
  6.  
  7. NNAAMMEE
  8.        XtFindFile - search for a file using substitutions in the
  9.        path list
  10.  
  11. SSYYNNTTAAXX
  12.        String XtFindFile(_p_a_t_h, _s_u_b_s_t_i_t_u_t_i_o_n_s,
  13.        _n_u_m___s_u_b_s_t_i_t_u_t_i_o_n_s,_p_r_e_d_i_c_a_t_e)
  14.          String _p_a_t_h;
  15.          Substitution _s_u_b_s_t_i_t_u_t_i_o_n_s;
  16.          Cardinal _n_u_m___s_u_b_s_t_i_t_u_t_i_o_n_s;
  17.          XtFilePredicate _p_r_e_d_i_c_a_t_e;
  18.  
  19. AARRGGUUMMEENNTTSS
  20.        _p_a_t_h     Specifies a path of file names, including sub-
  21.          stitution characters.
  22.  
  23.        _s_u_b_s_t_i_t_u_t_i_o_n_s
  24.          Specifies a list of substitutions to make into a
  25.          path.
  26.  
  27.        _n_u_m___s_u_b_s_t_i_t_u_t_i_o_n_s
  28.          Specifies the number of substitutions passed in.
  29.  
  30.        _p_r_e_d_i_c_a_t_e Specifies a procedure to call to judge a poten-
  31.          tial file name, or NULL.
  32.  
  33. DDEESSCCRRIIPPTTIIOONN
  34.        The _p_a_t_h parameter specifies a string that consists of a
  35.        series of potential file names delimited by colons.
  36.        Within each name, the percent character specifies a string
  37.        substitution selected by the following character.  The
  38.        character sequence ``%:'' specifies an embedded colon that
  39.        is not a delimiter; the sequence is replaced by a single
  40.        colon.  The character sequence ``%%'' specifies a percent
  41.        character that does not introduce a substitution; the
  42.        sequence is replaced by a single percent character.  If a
  43.        percent character is followed by any other character,
  44.        looks through the specified _s_u_b_s_t_i_t_u_t_i_o_n_s for that charac-
  45.        ter in the _m_a_t_c_h field and if found replaces the percent
  46.        and match characters with the string in the corresponding
  47.        _s_u_b_s_t_i_t_u_t_i_o_n field.  A _s_u_b_s_t_i_t_u_t_i_o_n field entry of NULL is
  48.        equivalent to a pointer to an empty string.  If the oper-
  49.        ating system does not interpret multiple embedded name
  50.        separators in the path (i.e., ``/'' in POSIX) the same way
  51.        as a single separator, will collapse multiple separators
  52.        into a single one after performing all string substitu-
  53.        tions.  Except for collapsing embedded separators, the
  54.        contents of the string substitutions are not interpreted
  55.        by and may therefore contain any operating-system-
  56.        dependent characters, including additional name separa-
  57.        tors.  Each resulting string is passed to the predicate
  58.        procedure until a string is found for which the procedure
  59.        returns this string is the return value for If no string
  60.        yields a return from the predicate, returns NULL.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XtFindFile(3Xt)           XT FUNCTIONS          XtFindFile(3Xt)
  71.  
  72.  
  73.        If the _p_r_e_d_i_c_a_t_e parameter is NULL, an internal procedure
  74.        that checks if the file exists, is readable, and is not a
  75.        directory will be used.
  76.  
  77.        It is the responsibility of the caller to free the
  78.        returned string using when it is no longer needed.
  79.  
  80. SSEEEE AALLSSOO
  81.        _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s _- _C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e
  82.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.