lustre/doc/llapi_layout_comp_flags_get.3

   1 .TH llapi_layout_comp_flags_get 3 "2017 Apr 7" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_comp_flags_get, llapi_layout_comp_flags_set,
   4 llapi_layout_comp_flags_clear \- get, set or clear the flags of a layout
   5 component.
   6 .SH SYNOPSIS
   7 .nf
   8 .B #include <lustre/lustreapi.h>
   9 .PP
  10 .BI "int llapi_layout_comp_flags_get(const struct llapi_layout *" layout ",
  11 .BI "                                uint32_t *" flags );
  12 .PP
  13 .BI "int llapi_layout_comp_flags_set(struct llapi_layout *" layout ",
  14 .BI "                                uint32_t " flags );
  15 .PP
  16 .BI "int llapi_layout_comp_flags_clear(struct llapi_layout *" layout ",
  17 .BI "                                  uint32_t " flags );
  18 .fi
  19 .SH DESCRIPTION
  20 .PP
  21 Layout component flags are used to indicate the status of the component, only
  22 LCME_FL_INIT is supported now, which indicates the OST objects of the component
  23 have been initialized.
  24 .PP
  25 .BR llapi_layout_comp_flags_get (3)
  26 gets the flags of
  27 .I layout
  28 and stores it into
  29 .IR flags .
  30 .PP
  31 .BR llapi_layout_comp_flags_set (3)
  32 sets the specified
  33 .I flags
  34 to the
  35 .IR layout .
  36 .PP
  37 .BR llapi_layout_comp_flags_clear (3)
  38 clears the specified
  39 .I flags
  40 from the
  41 .IR layout .
  42 .SH RETURN VALUES
  43 Return 0 on success, or -1 if an error occurred (in which case, errno is
  44 set appropriately).
  45 .SH ERRORS
  46 .TP 15
  47 .SM EINVAL
  48 An invalid argument was specified.
  49 .SH "SEE ALSO"
  50 .BR llapi_layout_alloc (3),
  51 .BR llapi_layout_file_open (3),
  52 .BR llapi_layout (7),
  53 .BR lustreapi (7)