lustre/doc/llapi_layout_stripe_size_get.3

   1 .TH llapi_layout_stripe_size_get 3 "2013 Oct 31" "Lustre User API"
   2 .SH NAME
   3 llapi_layout_stripe_size_get, llapi_layout_stripe_size_set \- get or set the
   4 stripe count of a Lustre file
   5 .SH SYNOPSIS
   6 .nf
   7 .B #include <lustre/lustreapi.h>
   8 .PP
   9 .BI "int llapi_layout_stripe_size_get(const struct llapi_layout *" layout ",
  10 .BI "                                 uint64_t *" stripe_size );
  11 .PP
  12 .BI "int llapi_layout_stripe_size_set(struct llapi_layout *" layout ",
  13 .BI "                                 uint64_t " stripe_size );
  14 .fi
  15 .SH DESCRIPTION
  16 .PP
  17 The stripe size indicates how much data to write to one OST before
  18 moving to the next OST.
  19 .PP
  20 .B llapi_layout_stripe_size_get()
  21 stores into
  22 .I stripe_size
  23 the stripe size of
  24 .IR layout .
  25 .PP
  26 .B llapi_layout_stripe_size_get()
  27 sets the stripe size of
  28 .I layout
  29 to
  30 .IR stripe_size .
  31 .PP
  32 A
  33 .I stripe_size
  34 value of
  35 .B LLAPI_LAYOUT_DEFAULT
  36 means that the default stripe size will be used.
  37 .SH RETURN VALUES
  38 .B llapi_layout_stripe_size_get()
  39 and
  40 .B llapi_layout_stripe_size_set()
  41 return 0 on success, or -1 if an error occurred (in which case, errno is
  42 set appropriately).
  43 .SH ERRORS
  44 .TP 15
  45 .SM EINVAL
  46 An invalid argument was specified.
  47 .SH "SEE ALSO"
  48 .BR llapi_layout_alloc (3),
  49 .BR llapi_layout_file_open (3),
  50 .BR llapi_layout_extension_size_set (3),
  51 .BR llapi_layout_extension_size_get (3),
  52 .BR llapi_layout (7),
  53 .BR lustreapi (7)