X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_auto.3;h=23005cb89d6c2260547122810ea99515c13e76da;hb=133c8ed7290daf0143bb14fba174be39996646a6;hp=d62a8d6ec42785f97a2e3ae670655d02d9ce64e8;hpb=db154fa6dbcd3bb64f16669df2f24abf80e49296;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_auto.3 b/docs/man/memcached_auto.3 index d62a8d6e..23005cb8 100644 --- a/docs/man/memcached_auto.3 +++ b/docs/man/memcached_auto.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_AUTO" "3" "October 18, 2011" "1.01" "libmemcached" +.TH "MEMCACHED_AUTO" "3" "July 05, 2012" "1.0.9" "libmemcached" .SH NAME memcached_auto \- Incrementing and Decrementing Values . @@ -35,35 +35,35 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] #include .INDENT 0.0 .TP -.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value); +.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP) .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value); +.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP) .UNINDENT .sp Compile and link with \-lmemcached @@ -73,41 +73,40 @@ Compile and link with \-lmemcached (overflow and underflow are not detected). This gives you the ability to use memcached to generate shared sequences of values. .sp -memcached_increment() takes a key and keylength and increments the value by -the offset passed to it. The value is then returned via the unsigned int +memcached_increment takes a key and keylength and increments the value by +the offset passed to it. The value is then returned via the uint32_t value pointer you pass to it. .sp -memcached_decrement() takes a key and keylength and decrements the value by -the offset passed to it. The value is then returned via the unsigned int +memcached_decrement takes a key and keylength and decrements the value by +the offset passed to it. The value is then returned via the uint32_t value pointer you pass to it. .sp -memcached_increment_with_initial() takes a key and keylength and increments +memcached_increment_with_initial takes a key and keylength and increments the value by the offset passed to it. If the object specified by key does not exist, one of two things may happen: If the expiration value is MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other expiration values, the operation will succeed by seeding the value for that key with a initial value to expire with the provided expiration time. The -flags will be set to zero.The value is then returned via the unsigned int +flags will be set to zero.The value is then returned via the uint32_t value pointer you pass to it. .sp -memcached_decrement_with_initial() takes a key and keylength and decrements +memcached_decrement_with_initial takes a key and keylength and decrements the value by the offset passed to it. If the object specified by key does not exist, one of two things may happen: If the expiration value is MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other expiration values, the operation will succeed by seeding the value for that key with a initial value to expire with the provided expiration time. The -flags will be set to zero.The value is then returned via the unsigned int +flags will be set to zero.The value is then returned via the uint32_t value pointer you pass to it. .sp -memcached_increment_by_key(), memcached_decrement_by_key(), -memcached_increment_with_initial_by_key(), and -memcached_decrement_with_initial_by_key() are master key equivalents of the -above. +\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP, +\fI\%memcached_increment_with_initial_by_key()\fP, and +\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above. .SH RETURN .sp -A value of type \fBmemcached_return_t\fP is returned. +A value of type \fBmemcached_return_t\fP is returned. On success that value will be \fBMEMCACHED_SUCCESS\fP. -Use memcached_strerror() to translate this value to a printable string. +Use memcached_strerror to translate this value to a printable string. .SH HOME .sp To find out more information please check: