lustre/doc/llapi_layout_stripe_count_get.3

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