lustre/doc/llapi_path2fid.3

   1 .TH llapi_path2fid 3 "2018-11-28" "Lustre User API"
   2 .SH NAME
   3 llapi_path2fid \- translate a path name to a File Identifier
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_path2fid(const char *" path ", struct lu_fid *" fid );
   9 .fi
  10 .SH DESCRIPTION
  11 .PP
  12 .BR llapi_path2fid()
  13 stores the Lustre file identifier (FID) for the file or directory named
  14 by
  15 .I path
  16 into
  17 .IR fid .
  18 The
  19 .I fid
  20 may be then be passed to other
  21 .B llapi_
  22 functions that expect the
  23 .B struct lu_fid
  24 data type.
  25 .SH RETURN VALUES
  26 .LP
  27 returns 0 on success or a negative errno value on failure.
  28 .SH ERRORS
  29 .TP 15
  30 .SM -EINVAL
  31 An invalid argument was specified.
  32 .TP
  33 .SM -ENOTTY
  34 .I path
  35 does not reside on a Lustre filesystem.
  36 .TP
  37 .SM -ENOENT
  38 .I path
  39 does not exist.
  40 .SH SEE ALSO
  41 .BR llapi_layout_get_by_fid (3),
  42 .BR llapi_layout (7),
  43 .BR llapi_fid2path (3),
  44 .BR llapi_path2parent (3),
  45 .BR lustreapi (7)