lustre/doc/llapi_layout_file_comp_del.3

   1 .TH llapi_layout_file_comp_del 3 "2015 Nov 4" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_file_comp_del \- delete the specified layout component
   4 from an existing file.
   5 .SH SYNOPSIS
   6 .nf
   7 .B #include <lustre/lustreapi.h>
   8 .PP
   9 .BI "int llapi_layout_file_comp_del(const char *" path ",
  10 .BI "                               uint32_t "id );
  11 .fi
  12 .SH DESCRIPTION
  13 .PP
  14 Deletes the layout component(s) specified by
  15 .I id
  16 from an existing file. The
  17 .I id
  18 can be a real unique component ID or a
  19 .IR lcme_id .
  20 Available
  21 .IR lcme_id
  22 are:
  23 .PP
  24 .BR LCME_ID_ALL:
  25 All components in the layout.
  26 .PP
  27 .BR LCME_ID_NONE|LCME_FL_INIT:
  28 All the instantiated components in the layout.
  29 .SH RETURN VALUES
  30 Returns 0 on success, or -1 if an error occurred (in which case, errno is
  31 set appropriately).
  32 .SH ERRORS
  33 .TP 15
  34 .SM EINVAL
  35 An invalid argument was specified.
  36 .TP
  37 .SM ENOENT
  38 .I path
  39 doesn't exist or the specified component isn't found in file.
  40 .SH TODO
  41 Add description for the
  42 .IR lcme_id .
  43 .SH "SEE ALSO"
  44 .BR llapi_layout_alloc (3),
  45 .BR llapi_layout_file_open (3),
  46 .BR llapi_layout_get_by_path (3),
  47 .BR llapi_layout_file_comp_add (3),
  48 .BR llapi_layout_comp_id_get (3),
  49 .BR llapi_layout_comp_move_at (3),
  50 .BR llapi_layout (7),
  51 .BR lustreapi (7)