Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XtFindFile(3)			  XT FUNCTIONS			   XtFindFile(3)

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

SYNTAX
     #include <X11/Intrinsic.h>

     char  *  XtFindFile(const	char *path, Substitution substitutions, Cardinal
	    num_substitutions, XtFilePredicate predicate);

ARGUMENTS
     path      Specifies a path of file names,	including  substitution  charac-
	       ters.

     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  poten-
     tial file names delimited by colons.  Within each name, the percent charac-
     ter  specifies  a	string substitution selected by the following character.
     The character sequence "%:" specifies an embedded colon that is not  a  de-
     limiter;  the  sequence  is  replaced by a single colon.  The character se-
     quence "%%" specifies a percent character that does not introduce a substi-
     tution; the sequence is replaced by a single percent character.  If a  per-
     cent 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 cor-
     responding substitution field.  A	substitution  field  entry  of	NULL  is
     equivalent  to  a pointer to an empty string.  If the operating system does
     not interpret multiple embedded name separators in the path (i.e.,  "/"  in
     POSIX)  the same way as a single separator, XtFindFile will collapse multi-
     ple separators into a single one after performing all string substitutions.
     Except for collapsing embedded separators, the contents of the string  sub-
     stitutions  are not interpreted by XtFindFile and may therefore contain any
     operating-system-dependent characters, including  additional  name  separa-
     tors.   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.

     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

X Version 11			   libXt 1.3.1			   XtFindFile(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XtFindFile&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help