lustre/doc/llapi_path2fid.3

   1 .TH llapi_path2fid 3 "2014 Mar 18" "Lustre User API"
   2 .SH NAME
   3 llapi_path2fid \- translate a path name to a Lustre FID
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_path2fid(const char *"path ", lustre_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 llapi functions that expect the
  21 .B lustre_fid
  22 data type.
  23 .SH RETURN VALUES
  24 .LP
  25 .B llapi_path2fid()
  26 returns 0 on success or a negative errno value on failure.
  27 .SH ERRORS
  28 .TP 15
  29 .SM -ENOTTY
  30 .I path
  31 does not reside on a Lustre filesystem.
  32 .TP
  33 .SM -ENOENT
  34 .I path
  35 does not exist.
  36 .TP
  37 .SM -EINVAL
  38 An invalid argument was specified.
  39 .SH "SEE ALSO"
  40 .BR llapi_layout_get_by_fid (3),
  41 .BR llapi_layout (7),
  42 .BR liblustreapi (7)