lustre/doc/llapi_layout_comp_id_get.3

   1 .TH llapi_layout_comp_id_get 3 "2017 Apr 7" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_comp_id_get  \- get the ID of a layout component.
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_layout_comp_id_get(const struct llapi_layout *" layout ",
   9 .BI "                             uint32_t *" comp_id );
  10 .fi
  11 .SH DESCRIPTION
  12 .PP
  13 Return the unique numeric ID
  14 .I comp_id
  15 of the currently active component of
  16 .IR layout .
  17 The ID of a component is a unique numeric identifier for the component
  18 within the layout of each file, and no age, ordering, relative position,
  19 or other sematics are implied by the component ID.  If a file's layout
  20 is modified a large number of times, the component ID may be re-used
  21 but will always be unique within a single file's layout.
  22 .PP
  23 .SH RETURN VALUES
  24 Return 0 on success.  Return -1 if an error occurred and set errno
  25 appropriately.
  26 .SH ERRORS
  27 .TP 15
  28 .SM EINVAL
  29 An invalid argument was specified.
  30 .SH "SEE ALSO"
  31 .BR llapi_layout_alloc (3),
  32 .BR llapi_layout_file_open (3),
  33 .BR llapi_layout_comp_use_id (3),
  34 .BR llapi_layout (7),
  35 .BR lustreapi (7)