lustre/doc/llapi_layout_comp_use_id.3

   1 .TH llapi_layout_comp_use_id 3 "2017 Apr 7" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_comp_use_id \- set currently active component to given ID
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_layout_comp_use_id(struct llapi_layout *" layout ",
   9 .BI "                             uint32_t *" comp_id );
  10 .fi
  11 .SH DESCRIPTION
  12 .PP
  13 Sets currently active component of
  14 .I layout
  15 to the component with specified
  16 .IR comp_id .
  17 .SH RETURN VALUES
  18 Return 0 on success. Otherwise, if an error occurred -1 is returned and
  19 .I errno
  20 is set appropriately.
  21 .SH ERRORS
  22 .TP 15
  23 .SM ENOENT
  24 No such component ID exists.
  25 .TP 15
  26 .SM EINVAL
  27 An invalid argument was specified.
  28 .SH "SEE ALSO"
  29 .BR llapi_layout_alloc (3),
  30 .BR llapi_layout_file_open (3),
  31 .BR llapi_layout_comp_del (3),
  32 .BR llapi_layout_comp_id_get (3),
  33 .BR llapi_layout_comp_use (3),
  34 .BR llapi_layout (7),
  35 .BR lustreapi (7)