MirOS Manual: XtFindFile(3)


XtFindFile(3Xt)           XT FUNCTIONS            XtFindFile(3Xt)

NAME

     XtFindFile - search for a file using substitutions in the
     path list

SYNTAX

     String XtFindFile(String path, Substitution substitutions,
          Cardinal num_substitutions, XtFilePredicate predicate);

ARGUMENTS

     path      Specifies a path of file names, including substi-
               tution characters.

     substitutions
               Specifies a list of substitutions to make into a
               path.

     num_substitutions
               Specifies the number of substitutions passed in.

     predicate Specifies a procedure to call to judge a potential
               file name, or NULL.

DESCRIPTION

     The path parameter specifies a string that consists of a
     series of potential file names delimited by colons.  Within
     each name, the percent character specifies a string substi-
     tution selected by the following character.  The character
     sequence ``%:'' specifies an embedded colon that is not a
     delimiter; the sequence is replaced by a single colon.  The
     character sequence ``%%'' specifies a percent character that
     does not introduce a substitution; the sequence is replaced
     by a single percent character.  If a percent character is
     followed by any other character, XtFindFile looks through
     the specified substitutions for that character in the match
     field and if found replaces the percent and match characters
     with the string in the corresponding substitution field.  A
     substitution field entry of NULL is equivalent to a pointer
     to an empty string.  If the operating system does not inter-
     pret multiple embedded name separators in the path (i.e.,
     ``/'' in POSIX) the same way as a single separator, XtFind-
     File will collapse multiple separators into a single one
     after performing all string substitutions.  Except for col-
     lapsing embedded separators, the contents of the string sub-
     stitutions are not interpreted by XtFindFile and may there-
     fore contain any operating-system-dependent characters,
     including additional name separators.  Each resulting string
     is passed to the predicate procedure until a string is found
     for which the procedure returns True; this string is the
     return value for XtFindFile. If no string yields a True
     return from the predicate, XtFindFile returns NULL.

XFree86                   Version 4.5.0                         1

XtFindFile(3Xt)           XT FUNCTIONS            XtFindFile(3Xt)

     If the predicate parameter is NULL, an internal procedure
     that checks if the file exists, is readable, and is not a
     directory will be used.

     It is the responsibility of the caller to free the returned
     string using XtFree when it is no longer needed.

SEE ALSO

     X Toolkit Intrinsics - C Language Interface
     Xlib - C Language X Interface

XFree86                   Version 4.5.0                         2

Generated on 2012-02-20 02:47:02 by $MirOS: src/scripts/roff2htm,v 1.70 2011/12/03 18:21:12 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002‒2011 The MirOS Project, Germany.
This product includes material provided by Thorsten Glaser.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.