]> sourceware.org Git - lvm2.git/commitdiff
Add lvm_lv_get_property() generic function to obtain value of any lv propert
authorDave Wysochanski <dwysocha@redhat.com>
Mon, 25 Oct 2010 14:09:08 +0000 (14:09 +0000)
committerDave Wysochanski <dwysocha@redhat.com>
Mon, 25 Oct 2010 14:09:08 +0000 (14:09 +0000)
Add a generic LV property function to lvm2app, similar to VG function.
Return lvm_property_value and require caller to check 'is_valid' flag
and lvm_errno() for API error.

liblvm/lvm2app.h
liblvm/lvm_lv.c

index fad9b0de6c1512db0120397d212138b9aae78514..a5f65e98d2cbb6b3235743b2e899fadcbbaa373e 100644 (file)
@@ -1032,6 +1032,44 @@ const char *lvm_lv_get_name(const lv_t lv);
  */
 uint64_t lvm_lv_get_size(const lv_t lv);
 
+/**
+ * Get the value of a LV property
+ *
+ * \memberof lv_t
+ *
+ * \param   lv
+ * Logical volume handle.
+ *
+ * \param   name
+ * Name of property to query.  See lvs man page for full list of properties
+ * that may be queried.
+ *
+ * The memory allocated for a string property value is tied to the vg_t
+ * handle and will be released when lvm_vg_close() is called.
+ *
+ * Example:
+ *      lvm_property_value v;
+ *      char *prop_name = "seg_count";
+ *
+ *      v = lvm_lv_get_property(lv, prop_name);
+ *      if (!v.is_valid) {
+ *           printf("Invalid property name or unable to query"
+ *                  "'%s', errno = %d.\n", prop_name, lvm_errno(libh));
+ *           return;
+ *      }
+ *      if (v.is_string)
+ *           printf(", value = %s\n", v.value.string);
+ *     if (v.is_integer)
+ *           printf(", value = %"PRIu64"\n", v.value.integer);
+ *
+ * \return
+ * lvm_property_value structure that will contain the current
+ * value of the property.  Caller should check 'is_valid' flag before using
+ * the value.  If 'is_valid' is not set, caller should check lvm_errno()
+ * for specific error.
+ */
+struct lvm_property_value lvm_lv_get_property(const lv_t lv, const char *name);
+
 /**
  * Get the current activation state of a logical volume.
  *
index 7bdafe098d95e515d3a724ce76b4c4446ba95e2c..cef87f542e0a8b49a400c92efdfc8c99f0d0d614 100644 (file)
@@ -48,6 +48,11 @@ const char *lvm_lv_get_name(const lv_t lv)
                               NAME_LEN+1);
 }
 
+struct lvm_property_value lvm_lv_get_property(const lv_t lv, const char *name)
+{
+       return get_property(NULL, NULL, lv, name);
+}
+
 uint64_t lvm_lv_is_active(const lv_t lv)
 {
        struct lvinfo info;
This page took 0.045635 seconds and 5 git commands to generate.