git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_create.pod

   1 =head1 NAME
   2
   3 memcached_create, memcached_free
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11 #include <memcached.h>
  12 memcached_st *memcached_create(memcached_st *ptr);
  13 void memcached_free(memcached_st *ptr);
  14
  15 =head1 DESCRIPTION
  16
  17
  18 memcached_create() is used to create a memcached_st structure that will then
  19 be used by other libmemcached functions to communicate with the server. You
  20 should either pass a statically declared memcached_st to memcached_create or
  21 a NULL. If a NULL passed in then a structure is allocated for you.
  22
  23 To clean up memory associated with a memcached_st structure you should pass
  24 it to memcached_free() when you are finished using it. memcached_free() is
  25 the only way to make sure all memory is deallocated when you finish using
  26 the structure.
  27
  28 =head1 RETURN
  29
  30 memcached_create() returns a pointer to the memcached_st that was created
  31 (or initialized). On an allocation failure, it returns null.
  32
  33 =head1 HOME
  34
  35 To find out more information please check: http://tangent.org/552/libmemcached.html
  36
  37 =head1 AUTHOR
  38
  39 Brian Aker, brian@tangent.org
  40
  41 =head1 SEE ALSO
  42
  43 memcached(1) libmemcached(3) memcached_strerror(3)
  44
  45 =cut
  46