lustre/doc/llapi_root_path_open.3

   1 .TH llapi_root_path_open 3 "2023 Apr 21" "Lustre User API"
   2 .SH NAME
   3 llapi_root_path_open \- Return open fd for a given device/path provided
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7
   8 .sp
   9 .BI "int llapi_root_path_open(const char *"device ", int *" fd " );
  10
  11 .sp
  12 .fi
  13 .SH DESCRIPTION
  14 .LP
  15 .B llapi_root_path_open(\|)
  16 is called with
  17 .I device
  18 which points to the FSNAME or complete path specifying a mountpount of Lustre
  19 filesystem. On success,
  20 .I fd
  21 is populated with valid descriptor.
  22
  23 .SH RETURN VALUES
  24 .LP
  25 .B llapi_root_path_open(\|)
  26 return:
  27 .TP
  28 >=0
  29 on success.
  30 .TP
  31 <0
  32 on failure.
  33 .fi
  34 .SH "SEE ALSO"
  35 .BR lustreapi (7)