lustre/doc/llapi_layout_comp_move.3

   1 .TH llapi_layout_comp_move 3 "2015 Nov 4" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_comp_move \- Move the current component of layout to a specified
   4 position: first, next or last.
   5 llapi_layout_comp_move_at \- Move the current component of layout to a component
   6 with specified component id.
   7 .SH SYNOPSIS
   8 .nf
   9 .B #include <lustre/lustreapi.h>
  10 .PP
  11 .BI "int llapi_layout_comp_move(struct llapi_layout *" layout ",
  12 .BI "                           uint32_t *" pos );
  13 .PP
  14 .BI "int llapi_layout_comp_move_at(struct llapi_layout *" layout ",
  15 .BI "                              uint32_t *" comp_id );
  16 .fi
  17 .SH DESCRIPTION
  18 .PP
  19 Moves the current component of the
  20 .IR layout .
  21 to a specified position.
  22 .PP
  23 .BR llapi_layout_comp_move (3)
  24 Moves current component to
  25 .IR pos .
  26 Available
  27 .IR pos
  28 are:
  29 .PP
  30 .BR LLAPI_LAYOUT_COMP_POS_FIRST:
  31 The first component of the layout.
  32 .PP
  33 .BR LLAPI_LAYOUT_COMP_POS_NEXT:
  34 The next component of current one.
  35 .PP
  36 .BR LLAPI_LAYOUT_COMP_POS_LAST:
  37 The last component of the layout.
  38 .PP
  39 .BR llapi_layout_comp_move_at (3)
  40 Moves current component to the component with specified
  41 .IR comp_id .
  42 .SH RETURN VALUES
  43 Return 0 on success, 1 when reaches last component when try to move next, or -1 if
  44 an error occurred (in which case, errno is 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_comp_id (3),
  53 .BR llapi_layout (7),
  54 .BR lustreapi (7)