X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_strerror.pod;h=332ea2d16c3a8f671778fc9fb88946dd653bfdec;hb=15082495242e0baf2248f255e8dac8eb286e81f2;hp=342d77fa9e16b4d6829c363f0070e5195d8fbb71;hpb=a11143256264a00e7437fa23ec8ff5196c5a5c0b;p=awesomized%2Flibmemcached diff --git a/docs/memcached_strerror.pod b/docs/memcached_strerror.pod old mode 100755 new mode 100644 index 342d77fa..332ea2d1 --- a/docs/memcached_strerror.pod +++ b/docs/memcached_strerror.pod @@ -8,31 +8,35 @@ C Client Library for memcached (libmemcached, -lmemcached) =head1 SYNOPSIS -#include -char *memcached_strerror(memcached_st *ptr, memcached_return rc); + #include + + char *memcached_strerror (memcached_st *ptr, + memcached_return rc); =head1 DESCRIPTION +memcached_strerror() takes a C value and returns a string +describing the error. + +This string must not be modified by the application. -memcached_strerror() takes a memcached_return value and returns a string -describing the error. memcahed_return values are returned from nearly all -libmemcached functions. They are a set of ENUM values describing all -possibly success and failure operations possible in the library. +C values are returned from nearly all libmemcached(3) functions. -memcached_return values are of an ENUM type so that you can set up responses +C values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values. =head1 RETURN -memcached_strerror() returns a string describing a memcached_return value. +memcached_strerror() returns a string describing a C value. =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