X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.pod;h=cbe6fc1ee91c6accde864424b66133bfb294d384;hb=02c35e9f14dddc82c86f246002b91bf8e25cbaa3;hp=61132d05c16bd5ee592380f72f307e26bb61d16d;hpb=a11143256264a00e7437fa23ec8ff5196c5a5c0b;p=m6w6%2Flibmemcached diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod index 61132d05..cbe6fc1e 100755 --- a/docs/memcached_create.pod +++ b/docs/memcached_create.pod @@ -8,19 +8,20 @@ C Client Library for memcached (libmemcached, -lmemcached) =head1 SYNOPSIS -#include -memcached_st *memcached_create(memcached_st *ptr); -void memcached_free(memcached_st *ptr); + #include -=head1 DESCRIPTION + memcached_st *memcached_create (memcached_st *ptr); + + void memcached_free (memcached_st *ptr); +=head1 DESCRIPTION -memcached_create() is used to create a memcached_st structure that will then -be used by other libmemcached functions to communicate with the server. You -should either pass a statically declared memcached_st to memcached_create or +memcached_create() is used to create a C structure that will then +be used by other libmemcached(3) functions to communicate with the server. You +should either pass a statically declared C to memcached_create() or a NULL. If a NULL passed in then a structure is allocated for you. -To clean up memory associated with a memcached_st structure you should pass +To clean up memory associated with a C structure you should pass it to memcached_free() when you are finished using it. memcached_free() is the only way to make sure all memory is deallocated when you finish using the structure. @@ -28,15 +29,16 @@ the structure. =head1 RETURN memcached_create() returns a pointer to the memcached_st that was created -(or initialized). On an allocation failure, it returns null. +(or initialized). On an allocation failure, it returns NULL. =head1 HOME -To find out more information please check: http://tangent.org/552/libmemcached.html +To find out more information please check: +L =head1 AUTHOR -Brian Aker, brian@tangent.org +Brian Aker, Ebrian@tangent.orgE =head1 SEE ALSO