git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/hashkit_is_allocated.3

   1 .TH "HASHKIT_IS_ALLOCATED" "3" "June 17, 2011" "0.49" "libmemcached"
   2 .SH NAME
   3 hashkit_is_allocated \- libhashkit Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 #include <libhashkit/hashkit.h>
  36 .INDENT 0.0
  37 .TP
  38 .B hashkit_st *hashkit_create(hashkit_st *hash);
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B void hashkit_free(hashkit_st *hash);
  47 .UNINDENT
  48 .INDENT 0.0
  49 .TP
  50 .B bool hashkit_is_allocated(const hashkit_st *hash);
  51 .UNINDENT
  52 .sp
  53 Compile and link with \-lhashkit
  54 .SH DESCRIPTION
  55 .sp
  56 The hashkit_create() function initializes a hashkit object for use. If
  57 you pass a NULL argument for hash, then the memory for the object is
  58 allocated. If you specify a pre\-allocated piece of memory, that is
  59 initialized for use.
  60 .sp
  61 The hashkit_clone() function initializes a hashkit object much like
  62 hashkit_create(), but instead of using default settings it will use
  63 the settings of the ptr hashkit object.
  64 .sp
  65 The hashkit_free() frees any resources being consumed by the hashkit
  66 objects that were initialized with hashkit_create() or hashkit_clone().
  67 .sp
  68 The hashkit_is_allocated() reports where the memory was allocated
  69 for a hashkit object.
  70 .SH RETURN VALUE
  71 .sp
  72 hashkit_create() and hashkit_clone() will return NULL on failure or
  73 non\-NULL on success.
  74 .sp
  75 hashkit_is_allocated() returns true if the memory for the hashkit
  76 object was allocated inside of hashkit_create() or hashkit_clone(),
  77 otherwise it is false and was user\-supplied memory.
  78 .SH HOME
  79 .sp
  80 To find out more information please check:
  81 \fI\%http://libmemcached.org/\fP
  82 .SH AUTHOR
  83 Brian Aker
  84 .SH COPYRIGHT
  85 2011, Brian Aker DataDifferential, http://datadifferential.com/
  86 .\" Generated by docutils manpage writer.
  87 .\"
  88 .