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 ", uint32_t "flags );
  11 .fi
  12 .SH DESCRIPTION
  13 .PP
  14 Deletes the layout component(s) specified by
  15 .I id
  16 or
  17 .I flags
  18 from an existing file. The
  19 .I id
  20 must be a real unique component ID, when
  21 .I flags
  22 is specified,
  23 .I id
  24 must be set to zero.
  25 Available
  26 .IR flags
  27 are:
  28 .PP
  29 .BR LCME_FL_INIT:
  30 Instantiated components in the layout.
  31 .PP
  32 .BR LCME_FL_NEG|LCME_FL_INIT:
  33 Uninstantiated components in the layout.
  34 .SH RETURN VALUES
  35 Returns 0 on success, or -1 if an error occurred (in which case, errno is
  36 set appropriately).
  37 .SH ERRORS
  38 .TP 15
  39 .SM EINVAL
  40 An invalid argument was specified.
  41 .TP
  42 .SM ENOENT
  43 .I path
  44 doesn't exist or the specified component isn't found in file.
  45 .SH "SEE ALSO"
  46 .BR llapi_layout_alloc (3),
  47 .BR llapi_layout_file_open (3),
  48 .BR llapi_layout_get_by_path (3),
  49 .BR llapi_layout_file_comp_add (3),
  50 .BR llapi_layout_comp_id_get (3),
  51 .BR llapi_layout_comp_use_id (3),
  52 .BR llapi_layout (7),
  53 .BR lustreapi (7)